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



NAME
       MPI_Errhandler_free  - Frees an MPI-style error handler.


SYNTAX
C Syntax
       #include <mpi.h>
       int MPI_Errhandler_free(MPI_Errhandler *errhandler)


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


C++ Syntax
       #include <mpi.h>
       void Errhandler::Free()


INPUT PARAMETER
       errhandler
                 MPI error handler (handle). Set to MPI_ERRHANDLER_NULL on exit.


OUTPUT PARAMETER
       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Marks  the  error  handler  associated  with  errhandler  for  deallocation  and  sets  errhandler to
       MPI_ERRHANDLER_NULL. The error handler will be deallocated after all communicators associated with it
       have been deallocated.


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.


SEE ALSO
       MPI_Comm_create_errhandler
       MPI_Comm_get_errhandler
       MPI_Comm_set_errhandler







Open MPI 1.2                                   September 2006                  MPI_Errhandler_free(3OpenMPI)