Newport XPS-D - Positionercompensatedfastpcocurrentstatusget

XPS Unified Programmer’s Manual
7.2.1.148 PositionerCompensatedFastPCOCurrentStatusGet
Name
PositionerCompensatedFastPCOCurrentStatusGet – Gets current status of
CIEFAST compensated PCO pulses generation.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the positioner name: (-18)
- Checks if CIEFAST compensated PCO pulses generation is enabled: (-121)
Description
This function gets the current status of CIEFAST compensated PCO pulses generation.
Status possible values:
0: Pulses generation inactive (idle, no error)
1: Pulses generation activated (running)
-1: Pulses generation aborted with errors.
Prototype
int PositionerCompensatedFastPCOCurrentStatusGet(
int SocketID,
char * FullPositionerName,
int * Status
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
Status int * PCO pulses generation status.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -18: Positioner Name doesn't exist or unknown command.
• -121: Function is not allowed due to configuration disabled.
EDH0373En1023 — 01/18 226