<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MPI_Type_set_attr</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<H1 id="MPI_Type_set_attr">MPI_Type_set_attr</H1>
Stores attribute value associated with a key
<H2>Synopsis</H2>
<PRE>
int MPI_Type_set_attr(MPI_Datatype datatype, int type_keyval, void *attribute_val)
</PRE>
<H2>Input Parameters</H2>
<DL>
<DT><B>datatype </B> <DD> MPI Datatype to which attribute will be attached (handle)
<DT><B>type_keyval </B> <DD> key value, as returned by <tt>MPI_Type_create_keyval</tt> (integer)
<DT><B>attribute_val </B> <DD> attribute value
</DL>
<P>
<H2>Notes</H2>
<P>
The type of the attribute value depends on whether C or Fortran is being used.
In C, an attribute value is a pointer (<tt>void *</tt>); in Fortran, it is an
address-sized integer.
<P>
If an attribute is already present, the delete function (specified when the
corresponding keyval was created) will be called.
<H2>Notes for Fortran</H2>
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
an additional argument <tt>ierr</tt> at the end of the argument list. <tt>ierr
</tt>is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
<tt>call</tt> statement.
<P>
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
</tt>in Fortran.
<P>
<H2>Errors</H2>
<P>
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
its use is deprecated. The predefined error handler
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Note that MPI does <em>not</em> guarentee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
<P>
<DL>
<DT><B>MPI_SUCCESS </B> <DD> No error; MPI routine completed successfully.
</DL>
<DL>
<DT><B>MPI_ERR_TYPE </B> <DD> Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see <tt>MPI_Type_commit</tt>) is used
in a communication call.
</DL>
<DL>
<DT><B>MPI_ERR_KEYVAL </B> <DD> Invalid keyval
</DL>
</BODY></HTML>