mpiControlInterruptWait

Declaration

long mpiControlInterruptWait(MPIControl  control,
                             MPI_BOOL    *interrupted,
                             MPIWait     timeout)

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. 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 either by a call to mpiControlInterruptWake(...).

If timeout is MPIWaitPOLL (0), then ControlInterruptWait will return immediately.

If timeout is MPIWaitFOREVER (-1), then ControlInterruptWait will wait forever for an interrupt.

Otherwise, ControlInterruptWait will wait timeout milliseconds for an interrupt.

NOTE: For Windows operating systems, only MPIWaitPOLL and MPIWaitFOREVER are valid timeout values.

See Also

mpiControlInterruptWake | mpiControlInteruptEnable