osx man page for mpi_errhandler_free

Query: mpi_errhandler_free

OS: osx

Section: 3openmpi

Links: osx man pages   all man pages

Forums: unix linux community   forum categories

Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar

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++ func- tions 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)
Related Man Pages
mpi_errhandler_get(3openmpi) - osx
mpi_op_free(3openmpi) - osx
mpi_win_free_keyval(3openmpi) - osx
mpi_win_get_errhandler(3openmpi) - osx
mpi_win_set_errhandler(3openmpi) - osx
Similar Topics in the Unix Linux Community
set -o vi giving set: Syntax error