Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 1.49 KB

MPI_Info_get_nthkey.3.rst

File metadata and controls

79 lines (51 loc) · 1.49 KB
Raw

MPI_Info_get_nthkey

MPI_Info_get_nthkey Returns the nth defined key in info.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Info_get_nthkey(MPI_Info info, int n, char *key)

Fortran Syntax

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

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

MPI_Info_get_nthkey returns the nth defined key in info. Keys are numbered 0...N - 1 where N is the value returned by 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 MPI_Info_set or MPI_Info_delete.

ERRORS

* MPI_Info_get * MPI_Info_get_nkeys * MPI_Info_get_valuelen