mpiCaptureArm

Declaration

	long mpiCaptureArm(MPICapture capture, MPI_BOOL arm)
	Required Header: stdmpi.h Change History: Modified in the 03.03.00

Description

mpiCaptureArm arms or disarms capture.

Note: Currently, mpiCaptureArm(…) does not wait for the capture object to change arm states. If you are changing the capture object state to disarmed before configuring capture, then you must make sure the state has changed before attempting to set the configuration. This can be accomplished by:

Polling the capture object’s state using mpiCaptureStatus(…) and monitoring MPICaptureStatus.state.
Putting the thread to sleep for a short time--calling meiPlatformSleep(2) will normally suffice.

*Value of "arm"*	*Action of mpiCaptureArm*
FALSE	Disarms capture and sets the state of *capture* to MPICaptureStateIDLE
TRUE	Arms capture and sets the state of *capture* to MPICaptureStateARMED

Return Values
MPIMessageOK