MPIErrhandlerfree(3OpenMPI) MPIErrhandlerfree(3OpenMPI)

NAME
       MMPPIIEErrrrhhaannddlleerrffrreeee  - Frees an MPI-style error handler.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIErrhandlerfree(MPIErrhandler *errhandler)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIERRHANDLERFREE(ERRHANDLER, IERROR)
            INTEGER   ERRHANDLER, IERROR


CC++++ SSyynnttaaxx
       #include 
       void Errhandler::Free()


IINNPPUUTT PPAARRAAMMEETTEERR
       errhandler
                 MPI  error  handler  (handle).  Set to MPIERRHANDLERNULL on
                 exit.


OOUUTTPPUUTT PPAARRAAMMEETTEERR
       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Marks the error handler associated with errhandler for deallocation and
       sets errhandler to MPIERRHANDLERNULL. The error handler will be deal-
       located after all communicators associated with it  have  been  deallo-
       cated.


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   MPIErrhandlerfree(3OpenMPI)