mpiRecorderRecordGet

Declaration
long mpiRecorderRecordGet(MPIRecorder       recorder,
                          long              countMax,
                          MPIRecorderRecord *record,
                          long              *count) 
Required Header stdmpi.h
Description

RecorderRecordGet obtains a Recorder's (recorder) data records. The record type must have been configured previously, by a prior call to mpiRecorderRecordConfig(...).

RecorderRecordGet gets a maximum of countMax records and writes them into the location pointed to by record (the location must be large enough to hold them). RecorderRecordGet also writes the actual number of records that were obtained to the location pointed to by count.

If the recorder data buffer is full and recording is enabled, recording will be temporarily disabled while either all or countMax records are obtained, whichever is less. Any records not obtained will be lost.

Return Values
MPIMessageOK if RecorderRecordGet successfully gets the data records
See Also mpiRecorderRecordConfig