mpiCaptureArm

Declaration

MPI_DECL1 MPI_RESULT MPI_DECL2
   mpiCaptureArm(MPICapture  capture,
                 MPI_BOOL    arm);	/* TRUE/FALSE */

Required Header: capture.h

Change History: Added in 04.00.

Description

mpiCaptureArm arms or disarms capture. When arming, the state of the capture engine changes to MPICaptureStateARMED. When disarming, the state of the capture engine changes to MPICaptureStateIDLE.

Note: The capture can be disarmed at any time, but can rearm only when in the capture state is the IDLE or CAPTURED. Currently, mpiCaptureArm() does not wait for the capture object to change arm states. If changing the capture object state to disarmed before configuring capture, 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.

capture
 A handle of a Capture object to arm.
arm
 TRUE to arm and set the capture state to MPICaptureStateARMED.
FALSE to disarm and set the capture state to MPICaptureStateIDLE.
Return Values

See Also

MPICaptureState