Open MPI logo

MPI_Comm_call_errhandler(3) man page (version 1.8.1)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

MPI_Comm_call_errhandler - Passes the supplied error code to the

error handler assigned to a communicator

Syntax

C Syntax


#include <mpi.h>
int MPI_Comm_call_errhandler(MPI_Comm comm, int errorcode)

Fortran Syntax


INCLUDE ’mpif.h’
MPI_COMM_CALL_ERRHANDLER(COMM, ERRORCODE, IERROR)
    INTEGER    COMM, ERRORCODE, IERROR

C++ Syntax


#include <mpi.h>
void MPI::Comm::Call_errhandler(int errorcode) const

Input Parameter

comm
communicator with error handler (handle).
errorcode
error code (integer).

Output Parameters

IERROR
Fortran only: Error status (integer).

Description

This function invokes the error handler assigned to the communicator comm with the supplied error code errorcode. If the error handler was successfully called, the process is not aborted, and the error handler returns, this function returns MPI_SUCCESS.

Notes

Users should note that the default error handler is MPI_ERRORS_ARE_FATAL. Thus, calling this function will abort the processes in comm if the default error handler has not been changed.

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++ functions 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.

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

See Also


MPI_Comm_create_errhandler
MPI_Comm_set_errhandler

« Return to documentation listing