MPI_Attr_put - Stores the attribute value associated with
a key
SYNOPSIS
C:
#include <mpi.h>
int MPI_Attr_put ( comm, keyval, attr_value )
MPI_Comm comm;
int keyval;
void *attr_value;
C++:
#include <mpi.h>
void Comm::Set_attr(
int comm_keyval,
const void* attribute_val) const
Fortran:
INCLUDE "mpif.h" (or USE MPI)
INTEGER comm, keyval, attr_value, ierror
CALL MPI_ATTR_PUT(comm, keyval, attr_value,
ierror)
STANDARDS
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_Attr_put routine stores the attribute value
associated with a key. This routine accepts the following
parameters:
comm Specifies the communicator to which the
attribute will be attached (handle)
keyval Specifies the key value, as returned by
MPI_Keyval_create(3) (integer)
attribute_val Specifies the attribute value
ierror Specifies the return code value for
successful completion, which is in
mpif.h file.
NOTES
Values of the permanent attributes MPI_TAG_UB, MPI_HOST,
and MPI_IO cannot be changed.
The type of the attribute value depends on whether C or
Fortran is being used. In C, an attribute value is a
pointer (void *). In Fortran, it is a single integer, .it
1 an-trap not a pointer, because Fortran has no pointers
and there are systems for which a pointer does not fit in
an integer (for example, any address system greater than
32 bits that uses 64 bits for Fortran double precision).
If an attribute is already present, the MPI_Attr_delete(3)
function (specified when the corresponding keyval was
created) will be called.
SEE ALSO
MPI_Attr_delete(3), MPI_Attr_get(3), MPI_Keyval_create(3)
Man(1) output converted with
man2html