Extended Functions; Abortmove - Newport XPS Programmer's Manual

XPS Unified
7.2.2

Extended Functions

The functions described in this section are for a specific controller configuration, please
contact Newport for further information.
7.2.2.1

AbortMove

Name
AbortMove – abort the motion or the jog in progress for the XY group.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
Description
This function allows aborting a motion or a jog in progress. The group status must be
"MOVING" or "JOGGING" else the (-22) error is returned.
If the group status is "MOVING", this function stops all motion in progress.
If the group status is "JOGGING", this function stops all "jog" motion in progress and
disables the jog mode. After this "group move abort" action, the group status becomes
"READY".
Prototype
int AbortMove(
int SocketID
)
Input parameters
SocketID
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -27: Move Aborted.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
589
Programmer's Manual
EDH0373En1023 — 01/18