mpiRecorderStart

Declaration 
long mpiRecorderStart(MPIRecorder  recorder,
                      long         count,
                      long         period,
                      long         fullCount)
Required Header stdmpi.h
Description

RecorderStart instructs a Recorder (recorder) to begin recording data records. The record type must have been configured previously, by a prior call to mpiRecorderRecordConfig(...).

An event of type MPIEventRECORDER_DONE will be generated when the recorder has finished collecting fullCount data records.

An event of type MPIEventRECORDER_FULL will be generated when the recorder is storing MPIRecorderConfig.fullCount records in its buffer.
  count
( for count > 0)		 specifies the total number of data records to record
  if count = -1 then recording is continuous, and uncollected records may be overwritten
  period
if period = 0 		frequency of recording in milliseconds
then data will be recorded as quickly as possible (on every sample)
  if fullCount > 0 then an event of type MPIEventRECORDER_FULL will be generated when the Recorder's data buffer contains fullCount data records
Return Values
MPIMessageOK if RecorderStart successfully instructs a Recorder to begin recording data records
See Also mpiRecorderRecordConfig | mpiRecorderStop