Newport XPS - Positionererrorget

XPS Unified Programmer’s Manual
7.2.1.241 PositionerErrorGet
Name
PositionerErrorGet – Gets the positioner error code and clears it.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Valids positioner name: (-18)
- Valids secondary positioner: (-18)
Description
This function gets the positioner error code and clears it.
The positioner error codes are listed in section 8.5: “Positioner Error List”. The
description of the positioner error code can be obtained with the
“GroupPositionerErrorStringGet” function.
NOTE
The “PositionerErrorRead” function reads the positioner error without clearing it.
Prototype
int PositionerErrorGet(
int SocketID,
char * FullPositionerName,
int * PositionerError
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
PositionerError int * Positioner error code.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -18: Positioner Name doesn't exist or unknown command.
• -24: Not available in this configuration (check hardware or configuration).
373 EDH0373En1023 — 01/18