Newport XPS-D - Tzencodercouplingmodeget

XPS Unified Programmer’s Manual
7.2.1.333 TZEncoderCouplingModeGet
Name
TZEncoderCouplingModeGet – Gets TZ encoder coupling mode.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the group name: (-19)
Description
This function gets the current state of encoder coupling mode (1=Enabled, 0=Disabled).
This API is reserved to TZ group only.
Prototype
int TZEncoderCouplingModeGet(
int SocketID,
char GroupName[250],
int * Mode
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * Group name.
Output parameters
Mode int * Encoder coupling mode.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -19: GroupName doesn't exist or unknown command.
EDH0373En1023 — 01/18 484