mpiRecorderDelete

Declaration

	long mpiRecorderDelete(MPIRecorder recorder)
	Required Header: stdmpi.h

Description

mpiRecorderDelete deletes a Recorder object and invalidates its handle (recorder). RecorderDelete is the equivalent of a C++ destructor.

It is possible to create a recorder object and not delete it, leaving the resources for the recorder occupied, but forgotten about (abandoned). It is most common to run into this situation when using an index of -1 for the recorder. When developing a program and running it in the debugger, it is common for the developer to exit the program without letting the program clean up its recorder resources. To see how to handle this situation programmatically, please see recorderinuse.c.

control

a handle to a Control object.

number

An index to the controller's data recorder. If (-1) is specified, the next available recorder object handle will be returned. The valid range is from -1 (next available recorder) to the controller's recordCount - 1.

When using (-1), make sure to delete the recorder object to free it for other applications. If the recorder object is not freed, it will not be accessible to another application until the controller is reset.

Return Values
MPIMessageOK