Gatheringexternalcurrentnumberget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.46

GatheringExternalCurrentNumberGet

Name
GatheringExternalCurrentNumberGet – Gets the current and maximum number of
externally gathered data points.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- External gathering must be configured: (-32)
Description
This function returns the current and maximum number of data points gathered during
an externally triggered data gathering.
For more thorough description of external data gathering capability, please refer to
section Data Gathering/External Data Gathering XPS Motion Tutorial.
Prototype
int GatheringExternalCurrentNumberGet(
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.
93
Programmer's Manual
EDH0373En1023 — 01/18