Newport XPS - Positionerusertravellimitsget

XPS Unified Programmer’s Manual
7.2.1.295 PositionerUserTravelLimitsGet
Name
PositionerUserTravelLimitsGet – Gets the user travel limits.
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)
- If piezo driver, check if driver is not initialized: (-118)
Description
This function returns the user-defined travel limits for the selected positioner.
Prototype
int PositionerUserTravelLimitsGet(
int SocketID,
char * FullPositionerName,
double * UserMinimumTarget,
double * UserMaximumTarget
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
UserMinimumTarget double * User minimum travel limit (units).
UserMaximumTarget double * User maximum travel limit (units).
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -118: Not allowed action driver not initialized.
439 EDH0373En1023 — 01/18