.\" Copyright 2006-2008 Sun Microsystems, Inc. .\" Copyright (c) 1996 Thinking Machines Corporation .TH MPI_Errhandler_free 3 "Feb 10, 2012" "1.4.5" "Open MPI" .SH NAME \fBMPI_Errhandler_free \fP \- Frees an MPI-style error handler. .SH SYNTAX .ft R .SH C Syntax .nf #include int MPI_Errhandler_free(MPI_Errhandler *\fIerrhandler\fP) .fi .SH Fortran Syntax .nf INCLUDE 'mpif.h' MPI_ERRHANDLER_FREE(\fIERRHANDLER, IERROR\fP) INTEGER \fIERRHANDLER, IERROR\fP .fi .SH C++ Syntax .nf #include void Errhandler::Free() .fi .SH INPUT PARAMETER .ft R .TP 1i errhandler MPI error handler (handle). Set to MPI_ERRHANDLER_NULL on exit. .SH OUTPUT PARAMETER .ft R .TP 1i IERROR Fortran only: Error status (integer). .SH DESCRIPTION .ft R 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. .SH 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. .sp 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. .SH SEE ALSO .ft R .sp MPI_Comm_create_errhandler .br MPI_Comm_get_errhandler .br MPI_Comm_set_errhandler