Groupkill - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.89

GroupKill

Name
GroupKill - Kills the selected group.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Valids object type (group): (-8), (-18)
- Valids group name: (-19)
Description
Kills the selected group to stop its action. The group returns to "NOTINIT" state. If the
group is already in this state then it stays there.
The GroupKill is a high priority command that is executed in any condition.
If an initialization, encoder calibration, homing, referencing, motion or trajectory
process is in progress, an "emergency stop" will be exectuted.
Error (-26) will be generated, for each of these functions.
Prototype
int GroupKill(
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.
• -8: Wrong object type for this command.
• -18: Positioner Name doesn't exist or unknown command.
• -19: GroupName doesn't exist or unknown command.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Group name.
146
Programmer's Manual