MPI_Info_get_nthkey function

  • Article

Returns the nth defined key in info object.

Syntax

int MPIAPI MPI_Info_get_nthkey(
   MPI_Info                           info,
   int                                n,
   _Out_z_cap_(MPI_MAX_INFO_KEY) char *key
);

Parameters

  • info
    Info object.

  • n
    Key number.

  • key
    Key. The maximum number of characters is MPI_MAX_INFO_KEY.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_INFO_GET_NTHKEY(INFO, N, KEY, IERROR)
        INTEGER INFO, N, IERROR
        CHARACTER*(*) KEY

Requirements

Product

HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities

Header

 Mpi.h; Mpif.h

Library

 Msmpi.lib

DLL

 Msmpi.dll

See also

MPI Info Object Functions