MPI_Errhandler_create(3) Open MPI MPI_Errhandler_create(3)
NAME
MPI_Errhandler_create - Creates an MPI-style error handler -- use of
this routine is deprecated.
SYNTAX
C Syntax
#include <mpi.h>
int MPI_Errhandler_create(MPI_Handler_function *function,
MPI_Errhandler *errhandler)
Fortran Syntax
INCLUDE 'mpif.h'
MPI_ERRHANDLER_CREATE(FUNCTION, ERRHANDLER, IERROR)
EXTERNAL FUNCTION
INTEGER ERRHANDLER, IERROR
INPUT PARAMETER
function User-defined error handling procedure.
OUTPUT PARAMETERS
errhandler
MPI error handler (handle).
IERROR Fortran only: Error status (integer).
DESCRIPTION
Note that use of this routine is deprecated as of MPI-2. Please use
MPI_Comm_create_errhandler instead.
This deprecated routine is not available in C++.
Registers the user routine function for use as an MPI exception han-
dler. Returns in errhandler a handle to the registered exception han-
dler.
In the C language, the user routine should be a C function of type
MPI_Handler_function, which is defined as
typedef void (MPI_Handler_function)(MPI_Comm *, int *, ...);
The first argument is the communicator in use. The second is the error
code to be returned by the MPI routine that raised the error. If the
routine would have returned MPI_ERR_IN_STATUS, it is the error code re-
turned in the status for the request that caused the error handler to
be invoked. The remaining arguments are stdargs arguments whose number
and meaning is implementation-dependent. An implementation should
clearly document these arguments. Addresses are used so that the han-
dler may be written in Fortran.
NOTE
The MPI-1 Standard states that an implementation may make the output
value (errhandler) simply the address of the function. However, the ac-
tion of MPI_Errhandler_ free makes this impossible, since it is re-
quired to set the value of the argument to MPI_ERRHANDLER_NULL. In ad-
dition, the actual error handler must remain until all communicators
that use it are freed.
ERRORS
Almost all MPI routines return an error value; C routines as the value
of the function and Fortran routines in the last argument. C++ func-
tions do not return errors. If the default error handler is set to
MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism
will be used to throw an MPI::Exception object.
Before the error value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job, except for
I/O function errors. The error handler may be changed with
MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN
may be used to cause error values to be returned. Note that MPI does
not guarantee that an MPI program can continue past an error.
SEE ALSO
MPI_Comm_create_errhandler
MPI_Comm_get_errhandler
MPI_Comm_set_errhandler
4.1.2 Nov 24, 2021 MPI_Errhandler_create(3)
Generated by dwww version 1.14 on Mon Jan 27 10:40:04 CET 2025.