MPI_Attr_put

Stores attribute value associated with a key

Synopsis

#include "mpi.h"
int MPI_Attr_put ( comm, keyval, attr_value )
MPI_Comm comm;
int      keyval;
void     *attr_value;

Input Parameters

	comm	communicator to which attribute will be attached (handle)
	keyval	key value, as returned by `MPI_KEYVAL_CREATE` (integer)
	attribute_val	attribute value

Notes

Values of the permanent attributes MPI_TAG_UB, MPI_HOST, MPI_IO, andMPI_WTIME_IS_GLOBAL may not 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 singleinteger (not a pointer, since Fortran has no pointers and there are systemsfor which a pointer does not fit in an integer (e.g., any > 32 bit addresssystem that uses 64 bits for Fortran DOUBLE PRECISION).

If an attribute is already present, the delete function (specified when thecorresponding keyval was created) will be called.

Notes for Fortran

All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK) havean additional argument ierr at the end of the argument list. ierris an integer and has the same meaning as the return value of the routinein C. In Fortran, MPI routines are subroutines, and are invoked with thecall statement.

All MPI objects (e.g., MPI_Datatype, MPI_Comm) are of type INTEGERin Fortran.

Errors

All MPI routines (except MPI_Wtime and MPI_Wtick) return an error value; C routines as the value of the function and Fortran routines in the lastargument. Before the value is returned, the current MPI error handler iscalled. By default, this error handler aborts the MPI job. The error handlermay be changed with MPI_Errhandler_set; the predefined error handlerMPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarentee that an MPI program can continue pastan error.

MPI_SUCCESS: No error; MPI routine completed successfully.

MPI_ERR_COMM: Invalid communicator. A common error is to use a null communicator in a call (not even allowed in MPI_Comm_rank).

MPI_ERR_OTHER: Other error; the error code associated with this error indicates an attempt to use an invalue keyval.