Gatheringexternalconfigurationset - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.45

GatheringExternalConfigurationSet

Name
GatheringExternalConfigurationSet – Sets an external data gathering.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks input external gathering mnemonic: (-29)
- Gathering must not be in progress: (-43)
Description
Defines one or several types of data gathered during externally triggered data gathering.
Maximum of 1000000 points can be acquired.
Maximum of 25 data types can be configured in a gathering.
Refer to section 8.4: "External Gathering Data Types".
The "GatheringExternalListGet" function can be used to retrieve a complete list of
gathering types.
For more thorough description of the external data gathering capability, please refer to
section Data Gathering/External Data Gathering XPS Motion Tutorial.
Prototype
int GatheringExternalConfigurationSet(
int SocketID,
int NbElements,
char * TypeArray
)
Input parameters
SocketID
NbElements
TypeArray
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -29: Mnemonic gathering type doesn't exist.
• -43: Gathering running.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
int Number of types.
char * Array of configured gathering types.
92
Programmer's Manual