Gatheringstopandsave - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.53

GatheringStopAndSave

Name
GatheringStopAndSave – Stops internally triggered data gathering and saves data into
the XPS controller.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks number of data (>0): (-30)
- Checks file opening: (-60)
Description
This function stops internally triggered data gathering as well as saves the data to the
XPS controller. Data is stored in GATHERING.DAT file under "..\Public" folder of the
XPS controller.
For more thorough description of internal data gathering capability, please refer to
section Data Gathering/Internal Data Gathering of XPS Motion Tutorial.
Prototype
int GatheringStopAndSave(
int SocketID
)
Input parameters
SocketID
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -30: Gathering not started.
• -60: Error during file writing or file doesn't exist.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
100
Programmer's Manual