17.2.49. MPI_Comm_create_errhandler

MPI_Comm_create_errhandler - Creates an error handler that can be attached to communicators.

17.2.49.1. Syntax

17.2.49.1.1. C Syntax

#include <mpi.h>

int MPI_Comm_create_errhandler(MPI_Comm_errhandler_function *function,
    MPI_Errhandler *errhandler)

17.2.49.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'

MPI_COMM_CREATE_ERRHANDLER(FUNCTION, ERRHANDLER, IERROR)
    EXTERNAL    FUNCTION
    INTEGER ERRHANDLER, IERROR

17.2.49.1.3. Fortran 2008 Syntax

USE mpi_f08

MPI_Comm_create_errhandler(comm_errhandler_fn, errhandler, ierror)
    PROCEDURE(MPI_Comm_errhandler_function) :: comm_errhandler_fn
    TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.49.2. Deprecated Type Name Note

MPI-2.2 deprecated the MPI_Comm_errhandler_fn and MPI::Comm::Errhandler_fn types in favor of MPI_Comm_errhandler_function and MPI::Comm::Errhandler_function, respectively. Open MPI supports both names (indeed, the _fn names are typedefs to the _function names).

17.2.49.3. Input Parameter

  • function : User-defined error handling procedure (function).

17.2.49.4. Output Parameters

  • errhandler : MPI error handler (handle).

  • IERROR : Fortran only: Error status (integer).

17.2.49.5. Description

MPI_Comm_create_errhandler creates an error handler that can be attached to communicators. This function is identical to MPI_Errhandler_create, the use of which is deprecated. In C, the user routine should be a function of type MPI_Comm_errhandler_function, which is defined as

typedef void MPI_Comm_errhandler_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. This typedef replaces MPI_Handler_function, the use of which is deprecated. In Fortran, the user routine should be of this form:

SUBROUTINE COMM_ERRHANDLER_FUNCTION(COMM, ERROR_CODE, ...)
   INTEGER COMM, ERROR_CODE

17.2.49.6. Errors

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. 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.