Newport XPS - Groupstatusget

XPS Unified Programmer’s Manual
7.2.1.108 GroupStatusGet
Name
GroupStatusGet – Gets the group status code.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Valids group name: (-19)
Description
Returns the group status code. The group status codes are listed in section 8.8: “Group
Status List”.
The description of group status code can be retrieved from “GroupStatusStringGet”
function.
Prototype
int GroupStatusGet(
int SocketID,
char * GroupName,
int * GroupStatus
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * Group name.
Output parameters
GroupStatus int * Status of the group.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -19: GroupName doesn't exist or unknown command.
171 EDH0373En1023 — 01/18