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
85
86
|
.. _mpi_info_get_valuelen:
MPI_Info_get_valuelen
=====================
.. include_body
:ref:`MPI_Info_get_valuelen` |mdash| Retrieves the length of the key value
associated with an info object.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Info_get_valuelen(MPI_Info info, const char *key,
int *valuelen, int *flag)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_INFO_GET_VALUELEN(INFO, KEY, VALUELEN, FLAG, IERROR)
INTEGER INFO, VALUELEN, IERROR
LOGICAL FLAG
CHARACTER*(*) KEY
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Info_get_valuelen(info, key, valuelen, flag, ierror)
TYPE(MPI_Info), INTENT(IN) :: info
CHARACTER(LEN=*), INTENT(IN) :: key
INTEGER, INTENT(OUT) :: valuelen
LOGICAL, INTENT(OUT) :: flag
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT PARAMETERS
----------------
* ``info``: Info object (handle).
* ``key``: Key (string).
OUTPUT PARAMETERS
-----------------
* ``valuelen``: Length of value arg (integer).
* ``flag``: Returns true if key defined, false if not (boolean).
* ``ierror``: Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Info_get_valuelen` retrieves the length of the *value* associated
with *key*. If *key* is defined, *valuelen* is set to the length of its
associated value and *flag* is set to true. If *key* is not defined,
*valuelen* is not touched and *flag* is set to false. The length
returned in C does not include the end-of-string character.
If *key* is larger than MPI_MAX_INFO_KEY, the call is erroneous.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Info_get`
* :ref:`MPI_Info_get_nkeys`
* :ref:`MPI_Info_get_nthkey`
|
