Controllerstatusstringget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.10

ControllerStatusStringGet

Name
ControllerStatusStringGet – Gets the controller's status description from a controller
status code.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
Description
This function returns the controller status description corresponding to a controller
status code (see section "Group Status List").
If the status code is not referenced then the "Unknown controller status code" message
will be returned.
Prototype
int ControllerStatusStringGet(
int SocketID,
int ControllerStatusCode,
char * ControllerStatusString
)
Input parameters
SocketID
ControllerStatusCode
Output parameters
ControllerStatus
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
int Socket identifier used in each function.
int Controller status code.
char * Controller status description.
52
Programmer's Manual