This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

MPI_Comm_set_errhandler(3OpenMPI)                                          MPI_Comm_set_errhandler(3OpenMPI)



NAME
       MPI_Comm_set_errhandler  - Attaches a new error handler to a communicator.


SYNTAX
C Syntax
       #include <mpi.h>
       int MPI_Comm_set_errhandler(MPI_Comm comm,
            MPI_Errhandler errhandler)


Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_COMM_SET_ERRHANDLER(COMM, ERRHANDLER, IERROR)
            INTEGER   COMM, ERRHANDLER, IERROR


C++ Syntax
       #include <mpi.h>
       void MPI::Comm::Set_errhandler(const MPI::Errhandler& errhandler)


INPUT/OUTPUT PARAMETER
       comm      Communicator (handle).


OUTPUT PARAMETERS
       errhandler
                 New error handler for communicator (handle).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPI_Comm_set_errhandler  attaches  a  new  error handler to a communicator. The error handler must be
       either a predefined error handler or an error handler created by a  call  to  MPI_Comm_create_errhan-dler. MPI_Comm_create_errhandler.
       dler. This call is identical to MPI_Errhandler_set, 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++ 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.

       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.




Open MPI 1.2                                   September 2006              MPI_Comm_set_errhandler(3OpenMPI)