Newport XPS - Groupreferencingstop

XPS Unified Programmer’s Manual
7.2.1.103 GroupReferencingStop
Name
GroupReferencingStop – Stops 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 “REFERENCING”: (-22)
Description
Stops the referencing mode and sets the group state to “READY”.
To use this function, the selected group must be in “REFERENCING” state, otherwise
error (-22) is returned.
The travel limits are checked before stopping referencing mode. Error (-35) is returned,
if the profiler position is out of range of the software travel limits and the group stays in
the “REFERENCING” state.
Prototype
int GroupReferencingStop(
int SocketID,
char * GroupName
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * Group name.
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.
• -35: Position is outside of travel limits.
165 EDH0373En1023 — 01/18