Positionerhardwarestatusstringget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.260

PositionerHardwareStatusStringGet

Name
PositionerHardwareStatusStringGet – Gets the positioner error description.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
Description
This function returns the hardware status description from a positioner hardware status
code.
See section 8.6: "Positioner Hardware Status List".
Prototype
int PositionerHardwareStatusStringGet(
int SocketID,
char * FullPositionerName,
int PositionerHardwareStatusCode,
char * PositionerHardwareStatusString
)
Input parameters
SocketID
FullPositionerName
PositionerHardwareStatusCode
Output parameters
PositionerHardwareStatusString
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
int Positioner hardware status code.
int *
398
Programmer's Manual
Positioner hardware status description.