Open MPI logo

MPI_Comm_call_errhandler(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Comm_call_errhandlerR] - Passes the supplied error code to the error handler assigned to a communicator

Syntax

C Syntax



C]#include <mpi.h>int MPI_Comm_call_errhandler(MPI_Comm comm, int errorcode)R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_COMM_CALL_ERRHANDLER(COMM, ERRORCODE, IERROR) INTEGER COMM, ERRORCODE, IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Comm_call_errhandler(comm, errorcode, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm INTEGER, INTENT(IN) :: errorcode INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameter

[bu]
C]commR] : communicator with error handler (handle).
[bu]
C]errorcodeR] : error code (integer).

Output Parameters

[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

This function invokes the error handler assigned to the C]commR]unicator C]commR] with the supplied error code C]errorcodeR]. If the error handler was successfully called, the process is not aborted, and the error handler returns, this function returns C]MPI_SUCCESS.R]

Notes

Users should note that the default error handler is C]MPI_ERRORS_ARE_FATALR]. Thus, calling this function will abort the processes in C]commR] 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. See the MPI man page for a full list of MPI error codes.

See Also

C]MPI_Comm_create_errhandlerR](3) C]MPI_Comm_set_errhandlerR](3)


Table of Contents

« Return to documentation listing