Newport XPS-D - Positionerdriverstatusget

XPS Unified Programmer’s Manual
7.2.1.236 PositionerDriverStatusGet
Name
PositionerDriverStatusGet – Gets the positioner driver status code.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the positioner (must be not a secondary positioner): (-18), (-24)
Description
This function returns the positioner driver status from the driver board.
Use the “PositionerDriverStatusStringGet” function to get the driver status description.
NOTE
See section 8.7: “Positioner Driver Status List”.
Prototype
int PositionerDriverStatusGet(
int SocketID,
char * FullPositionerName,
unsigned long * PositionerDriverStatus
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
PositionerDriverStatus unsigned long * Driver status code.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -18: Positioner name doesn't exist or unknown command.
• -24: Not available in this configuration (check hardware or configuration).
367 EDH0373En1023 — 01/18