Groupreferencingstart - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.102

GroupReferencingStart

Name
GroupReferencingStart – Starts the referencing mode.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Valids group name: (-19)
- Group status must be "NOT REFERENCED": (-22)
Description
Starts the referencing mode and sets the group status to "REFERENCING".
To use this function, the selected group must be in "NOT REFERENCED" state, or
error (22) is returned.
To stop the referencing mode and go to "READY" state, use "GroupReferencingStop"
function.
Prototype
int GroupReferencingStart(
int SocketID,
char * GroupName
)
Input parameters
SocketID
GroupName
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -19: GroupName doesn't exist or unknown command.
• -22: Not allowed action.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Group name.
164
Programmer's Manual