Positionercompensatedpcomemoryreset - Newport XPS Programmer's Manual

XPS Unified
7.2.1.162

PositionerCompensatedPCOMemoryReset

Name
PositionerCompensatedPCOMemoryReset – Resets CIE08 compensated PCO data
memory.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner name: (-18)
- Checks the positioner type: (-8)
- Checks the position encoder ("AquadB" or "AnalogInterpolated"): (-24)
- Checks the CIE board supports this function: (-115)
- Checks CIE08CompensatedPCOMode = Enabled (system.ini): (-121)
Description
This function resets the CIE08 compensated PCO data memory. This function is useful
to remove the data that was previously entered with the
PositionerCompensatedPCOLoadToMemory() function.
The function works only when the CIE08 compensated PCO mode configuration is
enabled (system.ini: CIE08CompensatedPCOMode = Enabled).
This function can be used only with a position encoder ("AquadB" or
"AnalogInterpolated"), otherwise (-24) error is returned.
Prototype
int PositionerCompensatedPCOMemoryReset(
int SocketID,
char * PositionerName
)
Input parameters
SocketID
PositionerName
Output parameters
None.
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.
• -24: Incorrect file name, bad section name, or not available in this
configuration (check hardware or configuration).
• -115: Function is not supported by current hardware
• -121: Function is not allowed due to configuration disabled.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
247
Programmer's Manual
EDH0373En1023 — 01/18