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
|
.. _mpi_info_get_nthkey:
MPI_Info_get_nthkey
===================
.. include_body
:ref:`MPI_Info_get_nthkey` |mdash| Returns the *n*\ th defined key in *info*.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Info_get_nthkey(MPI_Info info, int n, char *key)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_INFO_GET_NTHKEY(INFO, N, KEY, IERROR)
INTEGER INFO, N, IERROR
CHARACTER*(*) KEY
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Info_get_nthkey(info, n, key, ierror)
TYPE(MPI_Info), INTENT(IN) :: info
INTEGER, INTENT(IN) :: n
CHARACTER(LEN=*), INTENT(OUT) :: key
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT PARAMETERS
----------------
* ``info``: Info object (handle).
* ``n``: Key number (integer).
OUTPUT PARAMETERS
-----------------
* ``key``: Key (string).
* ``ierror``: Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Info_get_nthkey` returns the *n*\ th defined key in *info*. Keys are
numbered 0...\ *N* - 1 where *N* is the value returned by
:ref:`MPI_Info_get_nkeys`. All keys between 0 and *N* - 1 are guaranteed to be
defined. The number of a given key does not change as long as *info* is
not modified with :ref:`MPI_Info_set` or :ref:`MPI_Info_delete`.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Info_get`
* :ref:`MPI_Info_get_nkeys`
* :ref:`MPI_Info_get_valuelen`
|