Singleaxisthetaclampenable - Newport XPS Programmer's Manual

XPS Unified
7.2.1.306

SingleAxisThetaClampEnable

Name
SingleAxisThetaClampEnable – clamps a SingleAxisTheta group.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Valids object type (group): (-8)
- Valids positioner name: (-18)
- Valids group name: (-19)
Description
This function clamps the selected SingleAxisTheta group.
The group must be in the READY state. If clamping is successful, the group is clamped
and the group state becomes "CLAMPED".
Prototype
int SingleAxisThetaClampEnable(
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.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * SingleAxis group name.
451
Programmer's Manual
EDH0373En1023 — 01/18