MPI_Type_get_attr - Retrieves a data type attribute value
by key
SYNOPSIS
C:
#include <mpi.h>
int MPI_Type_get_attr ( type, type_keyval, attribute_val, flag )
MPI_Datatype type;
int type_keyval;
void *attribute_val;
int *flag;
Fortran:
INCLUDE "mpif.h" (or USE MPI)
INTEGER type, type_keyval, ierror
INTEGER(KIND=MPI_ADDRESS_KIND) attribute_val
LOGICAL flag
CALL MPI_TYPE_GET_ATTR(type, type_keyval, attrbute_value,
flag, ierror)
STANDARDS
This function is defined in the MPI-2 standard.
This release implements the MPI 1.2 standard, as
documented by the MPI Forum in the spring 1997 release of
MPI: A Message Passing Interface Standard.
DESCRIPTION
The MPI_Type_get_attr routine retrieves a data type
attribute value by key. This routine accepts the
following parameters:
type Specifies the data type to which the attribute
is attached (handle).
type_keyval
Specifies the key value (integer).
attribute_val
Returns the attribute value, unless flag is set
to false.
flag Specifies the presence of an attribute value.
If an attribute value was extracted, flag is set
to true. If no attribute is associated with the
key, flag is set to false.
completion, which is in MPI_SUCCESS.
MPI_SUCCESS is defined in the mpif.h file.
NOTES
Attributes must be extracted from the same language as
that in which they were inserted.
For C programs, even though the attribute_val argument is
declared as void, it is really the address of a void
pointer. See the standard for more details.
For Fortran programs, the attribute_val is a pointer to a
Fortran integer of kind MPI_ADDRESS_KIND, not a pointer to
a void.
SEE ALSO
MPI_Type_create(3), MPI_Type_set_attr(3),
MPI_Type_delete_attr(3), MPI_Type_create_keyval(3),
MPI_Type_free_keyval(3)
Man(1) output converted with
man2html