Newport XPS-D - Positionerstageparameterget

XPS Unified Programmer’s Manual
7.2.1.289 PositionerStageParameterGet
Name
PositionerStageParameterGet – Gets a stage parameter value from the stages.ini file.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the positioner name and the parameter name: (-24)
Description
This function returns stage parameter values from the stages.ini file of a selected
positioner.
The positioner name is the stage name. And the parameter name is read in the section
under this stage name.
Prototype
int PositionerStageParameterGet(
int SocketID,
char * FullPositionerName
char * ParameterName,
char * ParameterValue
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
ParameterName char * Parameter name.
Output parameters
ParameterValue char * Parameter value.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -13: Wrong parameter type in the command string: char * expected.
• -24: Not available in this configuration (check hardware or configuration).
EDH0373En1023 — 01/18 432