NAME

MPI_Errhandler_free - Frees an error handle

SYNOPSIS

#include <mpi.h> 
int MPI_Errhandler_free(MPI_Errhandler *errh ); 
#include <pmpi.h> 
int PMPI_Errhandler_free(MPI_Errhandler *errh ); 

INPUT PARAMETER

errh - the error handler handle (handle).

OUTPUT PARAMETER

errh - set to MPI_ERRHANDLER_NULL (handle).

DESCRIPTION

The MPI_Errhandler_free() function is used to free a user error handler handle errh . If the handle is successfully freed, it is set to MPI_ERRHANDLER_NULL. The builtin MPI handles MPI_ERRORS_ARE_FATAL and MPI_ERRORS_RETURN may not be freed by this function.

PMPI_Errhandler_free() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_ERR_ARG - Invalid handle.

SEE ALSO

MPI_ERRORS_ARE_FATAL (3) MPI_ERRORS_RETURN (3) MPI_Errhandler_create (3) MPI_Errhandler_set (3) MPI_Errhandler_get (3) MPI_Error_string (3) MPI_Error_class (3)

• Lockless
• MPI Documentation
• MPI_Errhandler_free