Datacollectionrequest - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.14

DataCollectionRequest

Name
DataCollectionRequest – Gets data collection frame.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
Description
This function return a frame that contains the requested first blocks (max 500) of
current data collection.
The frame length can be from 0 (no block) to 500 blocks depending on the time
between the successive calls of DataCollectionRequest function. If the number of
available blocks is smaller than the requested blocks in the function call, the actual
number of blocks will be returned without error.
Example of a frame containing 4 data blocks :
0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD
0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD
0x1234ABCD;0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD
0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD
0x1234ABCD 0x1234ABCD;0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD
0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD
0x1234ABCD 0x1234ABCD 0x1234ABCD;0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD
0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD
0x1234ABCD 0x1234ABCD 0x1234ABCD 0x1234ABCD
Prototype
int DataCollectionRequest(
int SocketID,
int NbRequestBlocks,
int *NbReturnBlocks,
char *Frame
)
Input parameters
SocketID
NbRequestBlocks
Output parameters
NbReturnBlocks
Frame
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
string Socket identifier used in each function.
int Number of data blocks to get.
int * Number of actually returned blocks.
char * Blocks of collected data.
56
Programmer's Manual