Newport XPS-D - Positionerbacklashget

XPS Unified Programmer’s Manual
7.2.1.145 PositionerBacklashGet
Name
PositionerBacklashGet – Gets the backlash compensation value.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the positioner type (must not be a secondary positioner): (-8)
Description
This function returns the backlash compensation value, defined in the “stages.ini” file or
by “PositionerBacklashSet” function, and the backlash status (“Enable” or “Disable”).
Prototype
int PositionerBacklashGet(
int SocketID,
char * FullPositionerName,
double * BacklashValue,
char * Status
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
BacklashValue double * Backlash compensation value (units).
Status char * Backlash status (“Enable” or “Disable”).
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
223 EDH0373En1023 — 01/18