Newport XPS - Getvarx

XPS Unified Programmer’s Manual
7.2.2.10 GetVarX
Name
GetVarX – Sets new value for a specified parameter name from stages.ini for Y
positioner.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks input parameter value: (-17)
- Checks positioner name: (-18)
- Verifies the positioner is from a XY group: (-22)
Description
Get parameter value from stages.ini file for the X positioner.
Prototype
int GetVarX(
int SocketID,
char * ParameterName,
double * ParameterValue
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
ParameterName char * Stages.ini parameter name.
Output parameters
ParameterValue double * The value to be set for the “ParameterName”.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -17: Parameter out of range or incorrect.
• -18: Positioner Name doesn't exist or unknown command.
• -22: Not allowed action.
599 EDH0373En1023 — 01/18