Positionercompensationdisturbancefileload - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.167

PositionerCompensationDisturbanceFileLoad

Name
PositionerCompensationDisturbanceFileLoad – Loads file to compensate
disturbance in requested direction (Positive or Negative).
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the filter number: (-17)
- Checks if the disturbance compenstion feature is allowed in the firmware: -205
- Checks if the disturbance compenstion is enabled in the requested direction: -22
Description
This function loads a file that contains the compensation of disturbance in one direction.
The file cannot be loaded if the disturbance compenstion in the requested direction is
already enabled. In this case, it can be disabled with the
PositionerCompensationDisturbanceDisable API.
Prototype
int PositionerCompensationDisturbanceFileLoad(
int SocketID,
char *PositionerName,
char *Direction,
char *FileName
)
Input parameters
SocketID
PositionerName
Direction
FileName
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.
• -17: Parameter out of range or incorrect.
• -22: Not allowed action
• -61: Error file corrupt or file doesn't exist
• -205: Not enable in your configuration
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
char* "Positive" or "Negative".
char * File name located in \Config folder.
254
Programmer's Manual