.

mpiCaptureConfigGet

Declaration

 
long mpiCaptureConfigGet(MPICapture       capture,
                         MPICaptureConfig *config,
                         void             *external) 
  Required Header: stdmpi.h

Description

mpiCaptureConfigGet gets a Capture object's (capture) configuration and writes it into the structure pointed to by config, and also writes it into the implementation-specific structure pointed to by external (if external is not NULL).

The a Capture object's configuration information in external is in addition to the Capture object's configuration information in config, i.e, the Capture object's configuration information in config and in external is not the same information. Note that config or external can be NULL (but not both NULL).

If a capture has been 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(...).

Remarks

*external should be NULL.

 
Return Values  
MPIMessageOK  

Capture Engine Diagram

See Also

mpiCaptureConfigSet | mpiCaptureConfigReset

 

       Legal Notice  |  Tech Email  |  Feedback
      
Copyright ©
2001-2021 Motion Engineering