Newport XPS - Groupspinmodestop

XPS Unified Programmer’s Manual
7.2.1.105 GroupSpinModeStop
Name
GroupSpinModeStop – Stops the motion of the spindle group.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the group type (must be a Spindle group): (-8)
- Checks the positioner name (must be a group name): (-18)
Description
This function stops the motion of a spindle group and sets the group state to READY.
To use this function, the group must be in SPINNING state, otherwise error (-22) is
returned.
Prototype
int GroupSpinModeStop(
int SocketID,
char * GroupName
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * Spindle group name.
Output parameters
None.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -18: Positioner Name doesn't exist or unknown command.
• -19: GroupName doesn't exist or unknown command.
• -22: Not allowed action.
167 EDH0373En1023 — 01/18