1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
|
.. _mpi_errhandler_free:
MPI_Errhandler_free
===================
.. include_body
:ref:`MPI_Errhandler_free` |mdash| Frees an MPI-style error handler.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Errhandler_free(MPI_Errhandler *errhandler)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_ERRHANDLER_FREE(ERRHANDLER, IERROR)
INTEGER ERRHANDLER, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Errhandler_free(errhandler, ierror)
TYPE(MPI_Errhandler), INTENT(INOUT) :: errhandler
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
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
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Comm_create_errhandler`
* :ref:`MPI_Comm_get_errhandler`
* :ref:`MPI_Comm_set_errhandler`
|