<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MPI_Errhandler_create</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<H1 id="MPI_Errhandler_create">MPI_Errhandler_create</H1>
Creates an MPI-style errorhandler
<H2>Synopsis</H2>
<PRE>
int MPI_Errhandler_create(MPI_Handler_function * function, MPI_Errhandler * errhandler)
</PRE>
<H2>Input Parameters</H2>
<DL>
<DT><B>function </B> <DD> user defined error handling procedure
</DL>
<P>
<H2>Output Parameters</H2>
<DL>
<DT><B>errhandler </B> <DD> MPI error handler (handle)
</DL>
<P>
<H2>Notes</H2>
The MPI Standard states that an implementation may make the output value
(errhandler) simply the address of the function. However, the action of
<tt>MPI_Errhandler_free</tt> makes this impossible, since it is required to set the
value of the argument to <tt>MPI_ERRHANDLER_NULL</tt>. In addition, the actual
error handler must remain until all communicators that use it are
freed.
<P>
<H2>Thread and Interrupt Safety</H2>
<P>
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as <tt>malloc
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
<P>
<H2>Deprecated Function</H2>
The MPI-2 standard deprecated a number of routines because MPI-2 provides
better versions. This routine is one of those that was deprecated. The
routine may continue to be used, but new code should use the replacement
routine.
The replacement routine for this function is <tt>MPI_Comm_create_errhandler</tt>.
<P>
<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_INTERN </B> <DD> This error is returned when some part of the MPICH
implementation is unable to acquire memory.
</DL>
<P>
<H2>See Also</H2>
MPI_Comm_create_errhandler, MPI_Errhandler_free
<br>
</BODY></HTML>