mpiControlInterruptWait
Declaration
MPI_DECL1 MPI_RESULT MPI_DECL2 mpiControlInterruptWait(MPIControl control, MPIControlInterruptPendingData *pendingData, MPI_BOOL* interrupted);
Required Header: stdmpi.h
Change History: Updated in 04.00.00.
Description
mpiControlInterruptWait waits for an interrupt from the motion controller if interrupts are enabled.
After the ControlInterruptWait method returns, if the location pointed to by interrupted contains TRUE, then an interrupt has occurred since the previous call to mpiControlInterruptWaitPend(…) with the same pendingData argument. After the ControlInterruptWait method returns, if the location pointed to by interrupted contains FALSE, then no interrupt has occurred, and the return of ControlInterruptWait was caused by a call to mpiControlInterruptWake(...).
Note: mpiControlInterruptWait cannot be used in isolation. It must be used in conjunction with mpiControlInterruptWaitPend(…) and mpiControlInterruptWaitCancel(…).