Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 1.22 KB

MPI_Attr_get.3.rst

File metadata and controls

65 lines (40 loc) · 1.22 KB
Raw

MPI_Attr_get

:ref:`MPI_Attr_get` |mdash| Retrieves attribute value by key |mdash| |deprecated_favor| :ref:`MPI_Comm_get_attr`.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Attr_get(MPI_Comm comm, int keyval,void *attribute_val,
     int *flag )

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'

MPI_ATTR_GET(COMM, KEYVAL, ATTRIBUTE_VAL, FLAG, IERROR)
     INTEGER COMM, KEYVAL, ATTRIBUTE_VAL, IERROR
     LOGICAL FLAG

INPUT PARAMETERS

  • comm: Communicator to which attribute is attached (handle).
  • keyval: Key value (integer).

OUTPUT PARAMETERS

  • attribute_val: Attribute value, unless flag = false.
  • flag: True if an attribute value was extracted; false if no attribute is associated with the key.
  • ierror: Fortran only: Error status (integer).

DESCRIPTION

Note that use of this routine is deprecated as of MPI-2, and was deleted in MPI-3. Please use :ref:`MPI_Comm_get_attr`. This function does not have a mpi_f08 binding.

ERRORS

.. seealso::
   * :ref:`MPI_Comm_get_attr`