17.2.393. MPI_T_pvar_reset

MPI_T_pvar_reset — Reset the value of a performance variable

17.2.393.1. SYNTAX

17.2.393.1.1. C Syntax

int MPI_T_pvar_reset(MPI_T_pvar_session pe_session,
    MPI_T_pvar_handle handle)

17.2.393.2. INPUT PARAMETERS

  • session: Performance experiment session.

  • handle: Performance variable handle or MPI_T_PVAR_ALL_HANDLES.

17.2.393.3. 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.

17.2.393.4. 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