Edit

Share via

MPI_Info_get function

  • Article

Retrieves the value associated with a key.

Syntax

int MPIAPI MPI_Info_get(
        MPI_Info                   info,
  _In_  char                       *key,
        int                        valuelen,
        _Out_z_cap_(valuelen) char *value,
  _Out_ int                        *flag
);

Parameters

  • info
    Info object.

  • key [in]
    Key.

  • valuelen
    Length of value argument.

  • value
    Value.

  • flag [out]
    True if key defined, false if not.

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(INFO, KEY, VALUELEN, VALUE, FLAG, IERROR)
        INTEGER INFO, VALUELEN, IERROR
        CHARACTER*(*) KEY, VALUE
        LOGICAL FLAG

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