Errorstringget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.20

ErrorStringGet

Name
ErrorStringGet – Gets the error description from a function error code.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
Description
The function returns the error description corresponding to a function error code (see
section 8.7: "Positioner Driver Status List").
If the error code is not referenced then the "Unknown error code" message will be
returned.
Prototype
int ErrorStringGet(int SocketID, int ErrorCode, char * ErrorString)
Input parameters
SocketID
ErrorCode
Output parameters
ErrorString
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
int Error code.
char * Error description.
62
Programmer's Manual