Newport XPS-D - Getxvelparams

XPS Unified Programmer’s Manual
7.2.2.15 GetXVelParams
Name
GetXVelParams – This API returns the current velocity parameter in µm/s for X axis.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks motion profile: (-8)
Description
This API returns the current velocity parameter in µm/s for X axis.
Prototype
int GetXVelParams(
int SocketID,
double * Xvelocity
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
Output parameters
Xvelocity double * X velocity in µm/s.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
EDH0373En1023 — 01/18 604