Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 1.56 KB

MPI_Type_get_attr.3.rst

File metadata and controls

78 lines (50 loc) · 1.56 KB
Raw

MPI_Type_get_attr

:ref:`MPI_Type_get_attr` |mdash| Returns the attribute associated with a data type.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Type_get_attr(MPI_Datatype type, int type_keyval, void *attribute_val, int *flag)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_TYPE_GET_ATTR(TYPE, TYPE_KEYVAL, ATTRIBUTE_VAL, FLAG, IERROR)
     INTEGER TYPE, TYPE_KEYVAL, IERROR
     INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE_VAL
     LOGICAL FLAG

Fortran 2008 Syntax

USE mpi_f08
MPI_Type_get_attr(datatype, type_keyval, attribute_val, flag, ierror)
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     INTEGER, INTENT(IN) :: type_keyval
     INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(OUT) :: attribute_val
     LOGICAL, INTENT(OUT) :: flag
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETERS

  • type: Data type to which the attribute is attached (handle).
  • type_keyval: Key value (integer).

OUTPUT PARAMETERS

  • attribute_val: Attribute value, unless flag = false
  • flag: "false" if no attribute is associated with the key (logical).
  • ierror: Fortran only: Error status (integer).

DESCRIPTION

For the given data type, :ref:`MPI_Type_get_attr` returns an attribute value that corresponds to the specified key value.

ERRORS

.. seealso::
   * :ref:`MPI_Type_set_attr`