mpiControlInterruptWait

Declaration
long mpiControlInterruptWait(MPIControl  control,
                             long        *interrupted,
                             MPIWait     timeout)
Required Header stdmpi.h
Description

ControlInterruptWait 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(...) or by a timeout that has occurred.

If timeout is MPIWaitFOREVER (-1), then ControlInterruptWait will wait forever for an interrupt
If timeout is MPIWaitPOLL (0), then ControlInterruptWait will return immediately
If timeout is a value (not 0 or -1), then ControlInterruptWait will wait for an interrupt for timeout milliseconds

Return Values
MPIMessageOK if ControlInterruptWait waits for an interrupt from the motion controller
See Also mpiControlInterruptWake | mpiControlInteruptEnable