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
59
|
.. _mpi_t_pvar_write:
MPI_T_pvar_write
================
.. include_body
:ref:`MPI_T_pvar_write` |mdash| Write the value of a control variable
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_T_pvar_write(MPI_T_pvar_session session, MPI_T_pvar_handle handle, const void *buf)
INPUT PARAMETERS
----------------
* ``session``: Performance experiment session.
* ``handle``: Performance variable handle.
* ``buf``: Initial address of storage location for variable value.
DESCRIPTION
-----------
:ref:`MPI_T_pvar_write` attempts to set the value of the performance variable
identified by the handle specified in *handle* in the session specified
in *session*. The value to be written is specified in *buf*. The caller
must ensure that the buffer specified in *buf* is large enough to hold
the entire value of the performance variable.
ERRORS
------
:ref:`MPI_T_pvar_write` will fail if:
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
* ``MPI_T_ERR_INVALID_HANDLE``: The handle is invalid or not associated with the session
* ``MPI_T_ERR_INVALID_SESSION``: Session argument is not a valid session
* ``MPI_T_ERR_PVAR_NO_WRITE``: Variable cannot be written
.. seealso::
* :ref:`MPI_T_pvar_handle_alloc`
* :ref:`MPI_T_pvar_get_info`
* :ref:`MPI_T_pvar_session_create`
|
