mpiRecorderConfigGet

Declaration

int32_t mpiRecorderConfigGet(MPIRecorder       recorder,
                          MPIRecorderConfig *config,
                          void              *external)

Required Header: stdmpi.h

Description

mpiRecorderConfigGet gets a Recorder's (recorder) configuration and writes it into the structure pointed to by config.

recorder	A handle to an Recorder object.
*config	A pointer to the MPIRecorderConfig structure.

Return Values
MPIMessageOK

Sample Code

/*
   This function configures the Recorder Settings. The Recorder 
   Period is the number of samples in between recording, if set to 0, 
   the recorder will record every sample. The highCount is the number 
   of samples that need to be recorded before a RecorderHigh event 
   will be triggered. If bufferWrap is specified as True, when the 
   recorder is full, the recorder will wrap in a circular buffer 
   and begin writing at the beginning of the recorder buffer without 
   any loss.
*/

int32_t recorderConfig(MPIRecorder  recorder, 
                    int32_t         recorderPeriod, 
                    int32_t         highCount, 
                    bool         bufferWrap)
{
   MPIRecorderConfig  recorderConfig;
   int32_t               returnValue;

   /* Get recorder configuration handle */
   returnValue = mpiRecorderConfigGet(recorder, 
                                      &recorderConfig); 
   if(returnValue != MPIMessageOK)
   {
     return returnValue;
   }

   /* Config recorder parameters */
   recorderConfig.period = recorderPeriod;
   recorderConfig.highCount = highCount;
   recorderConfig.bufferWrap = bufferWrap;

   /* Set recorder configuration using handle */
   returnValue = mpiRecorderConfigSet(recorder, 
                                      &recorderConfig);

   return returnValue;
}

mpiRecorderConfigGet

Declaration

Description

Sample Code

See Also