Positionerstageparameterset - Newport XPS Programmer's Manual

XPS Unified
7.2.1.290

PositionerStageParameterSet

Name
PositionerStageParameterSet – Saves a stage parameter value into 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)
- Checks the user rights (must be identified as administrator): (-107)
Description
This function saves a stage parameter value in the "stages.ini" file.
The positioner name sets the stage name and the parameter name is searched in the
section of this stage name. Once the parameter is found, the parameter value is modified
to the new value.
If file reading fails then (-61) error is returned
If file writing fails then (-60) error is returned
To use this function, the user must login with administrator rights ("Login"
function).
Prototype
int PositionerStageParameterSet(
int SocketID,
char * FullPositionerName
char * ParameterName,
char * ParameterValue
)
Input parameters
SocketID
FullPositionerName
ParameterName
Output parameters
ParameterValue
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -24: Not available in this configuration (check hardware or configuration).
• -60: Error during file writing or file doesn't exist.
• -61: Error file corrupt or file doesn't exist.
• -107: This function requires to be logged in with Administrator rights.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
char * Parameter name.
char * Parameter value.
433
Programmer's Manual
EDH0373En1023 — 01/18