mpiRecorderStart

Declaration

int32_t mpiRecorderStart(MPIRecorder  recorder,
                      int32_t         count); /* -1 => continuous, 
                                              >0 => # of records */

Required Header: stdmpi.h

Description

mpiRecorderStart commands the controller to begin recording data records. Before starting a recorder, it must be configured with mpiRecorderRecordConfig(...) or mpiRecordConfigGet / mpiRecordConfigSet.

recorder	a handle to a Recorder object
count	The number of data records to record. If (-1) is specified, the data recorder will continuously record until the buffer is full. If the host is retrieving data from the buffer faster than the controller can fill the buffer, the controller will continuously copy data to the buffer. The valid range is from -1 (continuous recording) to the maximum number of records available in the data recorder buffer. If bufferWrap is set to TRUE in MPIRecorderConfig, the recorder will record data continuously until it is stopped.

recorder

a handle to a Recorder object

count

The number of data records to record. If (-1) is specified, the data recorder will continuously record until the buffer is full. If the host is retrieving data from the buffer faster than the controller can fill the buffer, the controller will continuously copy data to the buffer. The valid range is from -1 (continuous recording) to the maximum number of records available in the data recorder buffer. If bufferWrap is set to TRUE in MPIRecorderConfig, the recorder will record data continuously until it is stopped.

Return Values
MPIMessageOK
MPIRecorderMessageSTARTED

mpiRecorderStart

Declaration

Description

See Also