17.2.89. MPI_Errhandler_free

MPI_Errhandler_free - Frees an MPI-style error handler.

17.2.89.1. SYNTAX

17.2.89.1.1. C Syntax

#include <mpi.h>

int MPI_Errhandler_free(MPI_Errhandler *errhandler)

17.2.89.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_ERRHANDLER_FREE(ERRHANDLER, IERROR)
     INTEGER ERRHANDLER, IERROR

17.2.89.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_Errhandler_free(errhandler, ierror)
     TYPE(MPI_Errhandler), INTENT(INOUT) :: errhandler
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.89.2. INPUT PARAMETER

  • errhandler: MPI error handler (handle). Set to MPI_ERRHANDLER_NULL on exit.

17.2.89.3. OUTPUT PARAMETER

  • IERROR: Fortran only: Error status (integer).

17.2.89.4. 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.

17.2.89.5. ERRORS

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.

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.