Newport XPS-D - Groupstatusstringget

XPS Unified Programmer’s Manual
7.2.1.109 GroupStatusStringGet
Name
GroupStatusStringGet – Gets the group status description from a group status code.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
Description
This function returns the group status description corresponding to a group status code
(see section 8.10: “Controller Status List”).
If the group status code is not referenced, “Error: ( “ undefined status” ) will be
returned.
Prototype
int GroupStatusStringGet(
int SocketID,
int GroupStatusCode,
char * GroupStatusString
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupStatusCode int Group status code.
Output parameters
GroupStatusString char * Group status description.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
EDH0373En1023 — 01/18 172