Open MPI logo

MPI_T_pvar_reset(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

MPI_T_pvar_reset - Reset the value of a performance variable

Syntax

C Syntax


#include <mpi.h>
int MPI_T_pvar_reset(MPI_T_pvar_session session, MPI_T_pvar_handle handle)

Input Parameters

session
Performance experiment session.
handle
Performance variable handle or MPI_T_PVAR_ALL_HANDLES.

Description

MPI_T_pvar_reset sets the performance variable specified by the handle in handle to its initial value. The special value MPI_T_PVAR_ALL_HANDLES can be passed in handle to reset all read-write handles in the session specified in session.

Errors

MPI_T_pvar_reset() will fail if:
[MPI_T_ERR_NOT_INITIALIZED]
The MPI Tools interface not initialized
[MPI_T_ERR_INVALID_HANDLE]
The handle is invalid
[MPI_T_ERR_INVALID_SESSION]
Session argument is not a valid session
[MPI_T_ERR_PVAR_NO_WRITE]
Variable cannot be reset

See Also


MPI_T_pvar_handle_alloc
MPI_T_pvar_get_info
MPI_T_pvar_session_create
MPI_T_pvar_write

« Return to documentation listing