MPICommcreateerrhandler(3OpenMPI) MPICommcreateerrhandler(3OpenMPI)

NAME
       MMPPIICCoommmmccrreeaatteeeerrrrhhaannddlleerr   -  Creates  an  error  handler that can be
       attached to communicators.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICommcreateerrhandler(MPICommerrhandlerfn *function,
            MPIErrhandler *errhandler)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPICOMMCREATEERRHANDLER(FUNCTION, ERRHANDLER, IERROR)
            EXTERNAL  FUNCTION
            INTEGER   ERRHANDLER, IERROR


CC++++ SSyynnttaaxx
       #include 
       static MPI::Errhandler
            MPI::Comm::Createerrhandler(MPI::Comm::Errhandlerfn*
            function)


IINNPPUUTT PPAARRAAMMEETTEERR
       function  User-defined error handling procedure (function).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       errhandler
                 MPI error handler (handle).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPICommcreateerrhandler  creates  an  error  handler  that  can   be
       attached  to  communicators.  This function is identical to MPIErrhan-
       dlercreate, the use of which is deprecated.

       In C, the user routine should be a function  of  type  MPICommerrhan-
       dlerfn, which is defined as

           typedef void MPICommerrhandlerfn(MPIComm *, int *, ...);

       The  first argument is the communicator in use. The second is the error
       code to be returned by the MPI routine  that  raised  the  error.  This
       typedef  replaces MPIHandlerfunction, the use of which is deprecated.

       In Fortran, the user routine should be of this form:

           SUBROUTINE COMMERRHANDLERFN(COMM, ERRORCODE, ...)
               INTEGER COMM, ERRORCODE

       In C++, the user routine should be of this form:

           typedef void MPI::Comm::Errhandlerfn(MPIComm &, int *, ...);


EERRRROORRSS
       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::ERRORSTHROWEXCEPTIONS, 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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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 2M0P0I6Commcreateerrhandler(3OpenMPI)