Gatheringcurrentnumberget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.40

GatheringCurrentNumberGet

Name
GatheringCurrentNumberGet – Gets the current and maximum number of gathered
data points.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Gathering must be configured: (-32)
Description
This function returns the current and maximum number of data points gathered during
the internal triggered data gathering.
For more thorough description of the internal data gathering capability, please refer to
section Data Gathering/Internal Data Gathering of XPS Motion Tutorial.
Prototype
int GatheringCurrentNumberGet(
int SocketID,
int * CurrentNumber,
int * MaxSamplesNumber
)
Input parameters
SocketID
Output parameters
CurrentNumber
MaxSamplesNumber
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -32: Gathering not configured.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
int * Current number during acquisition.
int * Maximum number of samples.
86
Programmer's Manual