Newport XPS-D - Positionerhardwarestatusget

XPS Unified Programmer’s Manual
7.2.1.259 PositionerHardwareStatusGet
Name
PositionerHardwareStatusGet – Gets the positioner hardware 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): (-8), (-18), (-24)
Description
This function returns the hardware status of the selected positioner. The positioner
hardware status is composed of the “corrector” hardware status and the “servitudes”
hardware status:
The “Corrector” returns the motor interface and the position encoder hardware status.
The “Servitudes” returns the general inhibit and the end of runs hardware status.
NOTE
See section 8.6: “Positioner Hardware Status List”.
Prototype
int PositionerHardwareStatusGet(
int SocketID,
char * FullPositionerName,
int * PositionerHardwareStatus
)
Input parameters
SocketID int Socket identifier gets by the “TCP_ConnectToServer”
function.
FullPositionerName char * Positioner name.
Output parameters
PositionerHardwareStatus int * Hardware 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.
397 EDH0373En1023 — 01/18