Lockless Inc

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 );

#include <mpi.h> void MPI::Errhandler::Free(void);

INCLUDE 'mpif.h' MPI_ERRHANDLER_FREE(errh , ierr ) INTEGER errh , ierr

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 MPI_ERRORS_RETURN and MPI_ERRORS_THROW_EXCEPTIONS 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 code. The the current MPI error handler is invoked if the 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.

In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.

MPI_SUCCESS - No error;

MPI_ERR_PENDING - Pending exception;

MPI_ERR_ARG - Invalid handle.

SEE ALSO

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

About Us Returns Policy Privacy Policy Send us Feedback
Company Info | Product Index | Category Index | Help | Terms of Use
Copyright © Lockless Inc All Rights Reserved.