Newport XPS-D - Xyptparametersget

XPS Unified Programmer’s Manual
7.2.1.377 XYPTParametersGet
Name
XYPTParametersGet – Gets PT trajectory parameters.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks group type (must be a XY group): (-8)
- Checks group name: (-19)
- Checks current executing trajectory type (must be PT): (-22)
- Not available in this configuration (PrecisionPlatform firmware only): (-24)
Description
This function returns the PT trajectory parameters (trajectory name and current
executing element number) of the current PT trajectory.
Prototype
int XYPTParametersGet(
int SocketID,
char GroupName[250],
char * FileName,
int * CurrentElementNumber
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * Group name.
Output parameters
FileName char * Currently executing trajectory file name.
CurrentElementNumber int * Currently executing element number.
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: Group name doesn't exist or unknown command.
• -22: Not allowed action.
• -24: Not available in this configuration.
551 EDH0373En1023 — 01/18