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 74 75 76 77 78 79 80 81 82 83 84
|
.. _mpi_comm_get_errhandler:
MPI_Comm_get_errhandler
=======================
.. include_body
:ref:`MPI_Comm_get_errhandler` |mdash| Retrieves error handler associated with a
communicator.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Comm_get_errhandler(MPI_Comm comm,
MPI_Errhandler *errhandler)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_COMM_GET_ERRHANDLER(COMM, ERRHANDLER, IERROR)
INTEGER COMM, ERRHANDLER, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Comm_get_errhandler(comm, errhandler, ierror)
TYPE(MPI_Comm), INTENT(IN) :: comm
TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT PARAMETER
---------------
* ``comm``: Communicator (handle).
OUTPUT PARAMETERS
-----------------
* ``errhandler``: New error handler for communicator (handle).
* ``ierror``: Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Comm_get_errhandler` retrieves the error handler currently associated
with a communicator. This call is identical to :ref:`MPI_Errhandler_get`, the
use of which is deprecated.
Returns in errhandler (a handle to) the error handler that is currently
associated with communicator ``comm``.
**Example:** A library function may register at its entry point the
current error handler for a communicator, set its own private error
handler for this communicator, and restore before exiting the previous
error handler.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Comm_create_errhandler`
* :ref:`MPI_Comm_set_errhandler`
|