Open MPI logo

MPI_Comm_get_errhandler(3) man page (version 1.2.9)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing



NAME

       MPI_Comm_get_errhandler   -  Retrieves  error handler associated with a
       communicator.

SYNTAX


C Syntax

       #include <mpi.h>
       int MPI_Comm_get_errhandler(MPI_Comm comm,
            MPI_Errhandler *errhandler)

Fortran Syntax

       INCLUDE 'mpif.h'
       MPI_COMM_GET_ERRHANDLER(COMM, ERRHANDLER, IERROR)
            INTEGER   COMM, ERRHANDLER, IERROR

C++ Syntax

       #include <mpi.h>
       MPI::Errhandler MPI::Comm::Get_errhandler() const

INPUT PARAMETER

       comm      Communicator (handle).

OUTPUT PARAMETERS

       errhandler
                 New error handler for communicator (handle).

       IERROR    Fortran only: Error status (integer).

DESCRIPTION

       MPI_Comm_get_errhandler retrieves the error handler  currently  associ-
       ated with a communicator. This call is identical to MPI_Errhandler_get,
       the use of which is deprecated.

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++ func-
       tions 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.

       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.

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

« Return to documentation listing