mpiCaptureConfigReset
Declaration
MPI_DECL1 MPI_RESULT MPI_DECL2
mpiCaptureConfigReset(MPICapture capture);
Required Header: capture.h
Change History: Added in 04.00.
Description
mpiCaptureConfigReset returns the capture object to its unmapped state. A capture object has no assumed resources and is unmapped under default conditions. When a capture is first created, its captureMotorNumber and feedbackMotorNumber are unmapped. Once a capture is configured, the next time that the capture object is created, it will retain the captureMotorNumber and feedbackMotorNumber that was previously assigned. mpiCaptureConfigReset() will return the capture object to its unmapped state.
If a capture was previously configured (non-default), use mpiCaptureConfigReset() to return the capture to the default configuration before calling mpiCaptureConfigGet() and mpiCaptureConfigSet(). Or if you do not call mpiCaptureConfigReset(), make sure that all members of the MPICaptureConfig{} structure are explicitly set before calling mpiCaptureConfigSet().
capture |
A capture handle of a Capture object to reset. |
|---|
| Return Values |
|---|
| MPIMessageOK |
See Also