Gatheringexternaldataget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.47

GatheringExternalDataGet

Name
GatheringExternalDataGet – Reads one line of data from current external gathering
buffer.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks index number: (-17)
• IndexPoint ≥ 0.
• IndexPoint <currently gathered data number.
- Checks gathering state: (-32)
Description
This function reads a line of data from current gathering gathering buffer. The buffer
line number is defined by the index of an acquired point.
The separator is ";" in the returned data line.
Gathering must be configured in order to use this function, otherwise (-32) error is
returned.
Prototype
int GatheringExternalDataGet(
int SocketID,
int IndexPoint,
char * DataBufferLine
)
Input parameters
SocketID
IndexPoint
Output parameters
DataBufferLine
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -17: Parameter out of range or incorrect.
• -32: Gathering not configured.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
int Index of an acquired data from the current
gathering buffer.
char * String contains values from the current buffer at
the selected
94
Programmer's Manual
index.