Blame www/www3/MPI_Type_set_attr.html

Packit Service c5cf8c
Packit Service c5cf8c
<HTML>
Packit Service c5cf8c
<HEAD>
Packit Service c5cf8c
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit Service c5cf8c
<TITLE>MPI_Type_set_attr</TITLE>
Packit Service c5cf8c
</HEAD>
Packit Service c5cf8c
<BODY BGCOLOR="FFFFFF">
Packit Service c5cf8c

MPI_Type_set_attr

Packit Service c5cf8c
Stores attribute value associated with a key 
Packit Service c5cf8c

Synopsis

Packit Service c5cf8c
Packit Service c5cf8c
int MPI_Type_set_attr(MPI_Datatype datatype, int type_keyval, void *attribute_val)
Packit Service c5cf8c
Packit Service c5cf8c

Input Parameters

Packit Service c5cf8c
Packit Service c5cf8c
datatype
MPI Datatype to which attribute will be attached (handle)
Packit Service c5cf8c
Packit Service c5cf8c
type_keyval
key value, as returned by <tt>MPI_Type_create_keyval</tt> (integer)
Packit Service c5cf8c
Packit Service c5cf8c
attribute_val
attribute value
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Notes

Packit Service c5cf8c

Packit Service c5cf8c
The type of the attribute value depends on whether C or Fortran is being used.
Packit Service c5cf8c
In C, an attribute value is a pointer (<tt>void *</tt>); in Fortran, it is an
Packit Service c5cf8c
address-sized integer.
Packit Service c5cf8c

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

Notes for Fortran

Packit Service c5cf8c
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
Packit Service c5cf8c
an additional argument <tt>ierr</tt> at the end of the argument list.  <tt>ierr
Packit Service c5cf8c
</tt>is an integer and has the same meaning as the return value of the routine
Packit Service c5cf8c
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
Packit Service c5cf8c
<tt>call</tt> statement.
Packit Service c5cf8c

Packit Service c5cf8c
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit Service c5cf8c
</tt>in Fortran.
Packit Service c5cf8c

Packit Service c5cf8c

Errors

Packit Service c5cf8c

Packit Service c5cf8c
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
Packit Service c5cf8c
C routines as the value of the function and Fortran routines in the last
Packit Service c5cf8c
argument.  Before the value is returned, the current MPI error handler is
Packit Service c5cf8c
called.  By default, this error handler aborts the MPI job.  The error handler
Packit Service c5cf8c
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
Packit Service c5cf8c
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
Packit Service c5cf8c
RMA windows).  The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
Packit Service c5cf8c
its use is deprecated.  The predefined error handler
Packit Service c5cf8c
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Packit Service c5cf8c
Note that MPI does not guarentee that an MPI program can continue past
Packit Service c5cf8c
an error; however, MPI implementations will attempt to continue whenever
Packit Service c5cf8c
possible.
Packit Service c5cf8c

Packit Service c5cf8c
Packit Service c5cf8c
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_TYPE
Invalid datatype argument. Additionally, this error can
Packit Service c5cf8c
occur if an uncommitted MPI_Datatype (see <tt>MPI_Type_commit</tt>) is used
Packit Service c5cf8c
in a communication call.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_KEYVAL
Invalid keyval
Packit Service c5cf8c
Packit Service c5cf8c
</BODY></HTML>