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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
.. _mpi_info_set:
MPI_Info_set
============
.. include_body
:ref:`MPI_Info_set` |mdash| Adds a key/value pair to *info*.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Info_set(MPI_Info info, const char *key, const char *value)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_INFO_SET(INFO, KEY, VALUE, IERROR)
INTEGER INFO, IERROR
CHARACTER*(*) KEY, VALUE
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Info_set(info, key, value, ierror)
TYPE(MPI_Info), INTENT(IN) :: info
CHARACTER(LEN=*), INTENT(IN) :: key, value
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT/OUTPUT PARAMETER
----------------------
* ``info``: Info object (handle).
INPUT PARAMETERS
----------------
* ``key``: Key (string).
* ``value``: Value (string).
OUTPUT PARAMETER
----------------
* ``ierror``: Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Info_set` adds the (key,value) pair to *info* and overrides the value
if a value for the same key was previously set. The *key* and *value*
parameters are null-terminated strings in C. In Fortran, leading and
trailing spaces in *key* and *value* are stripped. If either *key* or
*value* is larger than the allowed maximums, the error MPI_ERR_INFO_KEY
or MPI_ERR_INFO_VALUE is raised, respectively.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Info_create`
* :ref:`MPI_Info_delete`
* :ref:`MPI_Info_dup`
* :ref:`MPI_Info_free`
* :ref:`MPI_Info_set`
|
