Newport XPS-D - Groupvelocitysetpointget

XPS Unified Programmer’s Manual
7.2.1.111 GroupVelocitySetpointGet
Name
GroupVelocitySetpointGet – Gets the setpoint velocity for one or all positioners of the
selected group.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks group type: (-8)
- Checks positioner name: (-18)
- Checks group name: (-19)
Description
Gets the setpoint velocity for one or all positioners of the selected group.
Prototype
int GroupVelocitySetpointGet(
int SocketID,
char * GroupName[250],
int NbPositioners,
double * SetpointVelocity
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * Group or positioner name.
NbPositioners int Number of positioners in the group.
Output parameters
SetpointVelocity double * Setpoint velocity array.
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: Group name doesn't exist or unknown command.
EDH0373En1023 — 01/18 174