17.2.322. MPI_Session_get_errhandler

MPI_Session_get_errhandler - Retrieves error handler associated with a session.

17.2.322.1. SYNTAX

17.2.322.1.1. C Syntax

#include <mpi.h>

int MPI_Session_get_errhandler(MPI_Session session,
     MPI_Errhandler *errhandler)

17.2.322.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_SESSION_GET_ERRHANDLER(SESSION, ERRHANDLER, IERROR)
     INTEGER SESSION, ERRHANDLER, IERROR

17.2.322.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_Session_get_errhandler(session, errhandler, ierror)
     TYPE(MPI_Session), INTENT(IN) :: session
     TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.322.2. INPUT PARAMETER

  • session: Session (handle).

17.2.322.3. OUTPUT PARAMETERS

  • errhandler: New error handler for session (handle).

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

17.2.322.4. DESCRIPTION

MPI_Session_get_errhandler retrieves the error handler currently associated with a session.

17.2.322.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.

See the MPI man page for a full list of MPI error codes.