1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
.. _mpi_t_pvar_reset:
MPI_T_pvar_reset
================
.. include_body
:ref:`MPI_T_pvar_reset` |mdash| Reset the value of a performance variable
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#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
-----------
:ref:`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
------
:ref:`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
.. seealso::
* :ref:`MPI_T_pvar_handle_alloc`
* :ref:`MPI_T_pvar_get_info`
* :ref:`MPI_T_pvar_session_create`
* :ref:`MPI_T_pvar_write`
|
