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
85
86
87
88
89
90
91
92
93
|
.. _mpi_comm_create_errhandler:
MPI_Comm_create_errhandler
==========================
.. include_body
:ref:`MPI_Comm_create_errhandler` |mdash| Creates an error handler that can be
attached to communicators.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Comm_create_errhandler(MPI_Comm_errhandler_function *function,
MPI_Errhandler *errhandler)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_COMM_CREATE_ERRHANDLER(FUNCTION, ERRHANDLER, IERROR)
EXTERNAL FUNCTION
INTEGER ERRHANDLER, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Comm_create_errhandler(comm_errhandler_fn, errhandler, ierror)
PROCEDURE(MPI_Comm_errhandler_function) :: comm_errhandler_fn
TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
Deprecated Type Name Note
-------------------------
MPI-2.2 deprecated the ``MPI_Comm_errhandler_fn`` type in favor of
``MPI_Comm_errhandler_function``.
Open MPI supports both names (indeed, the ``_fn`` names are
typedefs to the ``_function`` names).
INPUT PARAMETER
---------------
* ``function`` : User-defined error handling procedure (function).
OUTPUT PARAMETERS
-----------------
* ``errhandler`` : MPI error handler (handle).
* ``ierror`` : Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Comm_create_errhandler` creates an error handler that can be
attached to communicators. This ``function`` is identical to
:ref:`MPI_Errhandler_create`, the use of which is deprecated. In C, the
user routine should be a ``function`` of type
``MPI_Comm_errhandler_function``, which is defined as
.. code-block:: c
typedef void MPI_Comm_errhandler_function(MPI_Comm *, int *, ...);
The first argument is the communicator in use. The second is the error
code to be returned by the MPI routine that raised the error. This
typedef replaces ``MPI_Handler_function``, the use of which is
deprecated. In Fortran, the user routine should be of this form:
.. code-block:: fortran
SUBROUTINE COMM_ERRHANDLER_FUNCTION(COMM, ERROR_CODE, ...)
INTEGER COMM, ERROR_CODE
ERRORS
------
.. include:: ./ERRORS.rst
|
