MPIErrhandlercreate(3OpenMPI) MPIErrhandlercreate(3OpenMPI)

NAME
       MMPPIIEErrrrhhaannddlleerrccrreeaattee   -  Creates an MPI-style error handler - use of
       this routine is deprecated.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIErrhandlercreate(MPIHandlerfunction *function,
            MPIErrhandler *errhandler)


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



IINNPPUUTT PPAARRAAMMEETTEERR
       function  User-defined error handling procedure.


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       errhandler
                 MPI error handler (handle).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Note that use of this routine is deprecated as  of  MPI-2.  Please  use
       MPICommcreateerrhandler instead.

       This deprecated routine is not available in C++.

       Registers  the  user  routine function for use as an MPI exception han-
       dler. Returns in errhandler a handle to the registered  exception  han-
       dler.

       In  the  C  language,  the  user routine should be a C function of type
       MPIHandlerfunction, which is defined as

           typedef void (MPIHandlerfunction)(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. If the
       routine would have returned MPIERRINSTATUS, it  is  the  error  code
       returned in the status for the request that caused the error handler to
       be invoked. The remaining arguments are stdargs arguments whose  number
       and  meaning  is  implementation-dependent.  An  implementation  should
       clearly document these arguments. Addresses are used so that  the  han-
       dler may be written in Fortran.


NNOOTTEE
       The  MPI-1  Standard  states that an implementation may make the output
       value (errhandler) simply the address of  the  function.  However,  the
       action  of  MPIErrhandler  free  makes  this  impossible, since it is
       required to set the value of the argument  to  MPIERRHANDLERNULL.  In
       addition,  the actual error handler must remain until all communicators
       that use it are freed.


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.


SEE ALSO
       MPICommcreateerrhandler
       MPICommgeterrhandler
       MPICommseterrhandler






Open MPI 1.2                    September 2006 MPIErrhandlercreate(3OpenMPI)