Getgantrymode - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.2.6

GetGantryMode

Name
GetGantryMode – Gets Gantry mode.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the set option: (-17)
- Checks the group name is valid: (-19)
- Verifies gantry mode getting is allowed: (-22)
Description
Get the current gantry option. Three "gantry" options are available:
• Option0 = >Gantry standard.
• Option1 = >Gantry force balance.
• Option2 = >Gantry force balance with interferometer.
Prototype
int GetGantryMode(
int SocketID,
char * Option
)
Input parameters
SocketID
Output parameters
Option
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -17: Parameter out of range or incorrect.
• -19: GroupName doesn't exist or unknown command.
• -22: Not allowed action.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Option selection(Option0, Option1 or Option2).
594
Programmer's Manual