mpiRecorderRecordGet
Declaration
long mpiRecorderRecordGet(MPIRecorder recorder, long countMax, MPIRecorderRecord *record, long *count)
Required Header: stdmpi.h
Description
mpiRecorderRecordGet 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. Therefore, this function needs to be called before reading any recorded data using record.
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.
| recorder | A handle to a Recorder object. |
|---|---|
| countMax | The maximum number of records to read from the controller’s recorder buffer. |
| *record | A pointer to an array of MPIRecorderRecord structures, containing the recorded data. |
| *count | The number of records copied into the array of MPIRecorderRecord structures. |
| Return Values |
|---|
| MPIMessageOK |