17.2.318. MPI_Session_create_errhandler

MPI_Session_create_errhandler - Creates an error handler that can be attached to sessions

17.2.318.1. Syntax

17.2.318.1.1. C Syntax

#include <mpi.h>

int MPI_Session_create_errhandler(MPI_Session_errhandler_function *function,
    MPI_Errhandler *errhandler)

17.2.318.1.2. Fortran Syntax

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

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

17.2.318.1.3. Fortran 2008 Syntax

USE mpi_f08

MPI_Session_create_errhandler(session_errhandler_fn, errhandler, ierror)
    PROCEDURE(MPI_Session_errhandler_function) :: session_errhandler_fn
    TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.318.2. Input Parameter

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

17.2.318.3. Output Parameters

  • errhandler : MPI error handler (handle).

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

17.2.318.4. Description

MPI_Session_create_errhandler creates an error handler that can be attached to sessions. 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_Session_errhandler_function, which is defined as

typedef void MPI_Session_errhandler_function(MPI_Session *, int *, ...);

The first argument is the session 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 SESSION_ERRHANDLER_FUNCTION(SESSION, ERROR_CODE, ...)
   INTEGER SESSION, ERROR_CODE

17.2.318.5. 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_Session_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.