Newport XPS - Tzfocusmodeenable

XPS Unified Programmer’s Manual
7.2.1.336 TZFocusModeEnable
Name
TZFocusModeEnable – Enables the TZ group to go in FOCUS state.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the group type (must be a TZ group): (-8)
- Checks the positioner name: (-18)
- Checks the group name: (-19)
- Group state must be "READY”: (-22)
Description
This function enables the focus mode for the TZ group.
To use this function, The TZ group must be in READY state. If it’s not then (-22) error
is returned.
Prototype
int TZFocusModeEnable(
int SocketID,
char * GroupName
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * TZ group name.
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.
• -19: GroupName doesn't exist or unknown command.
• -22: Not allowed action.
487 EDH0373En1023 — 01/18