Positionererrorread - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.242

PositionerErrorRead

Name
PositionerErrorRead – Gets the positioner error code without clearing 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 without clearing 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.
The "PositionerErrorGet" function clears the positioner error.
Prototype
int PositionerErrorRead(
int SocketID,
char * FullPositionerName,
int * PositionerError
)
Input parameters
SocketID
FullPositionerName
Output parameters
PositionerError
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).
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
int * Positioner error code.
374
Programmer's Manual