Positionermagnetictrackpositionathomeget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.262

PositionerMagneticTrackPositionAtHomeGet

Name
PositionerMagneticTrackPositionAtHomeGet – Gets magnetic track position at
home in units.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the object type of this command is valid: (-8)
Description
This function returns the system compensation parameters defined for the second order
low-pass filter.
Prototype
int PositionerMagneticTrackPositionAtHomeGet(
int SocketID,
char * PositionerName,
double * MagneticTrackPosition
)
Input parameters
SocketID
PositionerName
Output parameters
MagneticTrackPosition
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double * magnetic track position at home (units).
400
Programmer's Manual