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
|
.. _mpi_add_error_string:
MPI_Add_error_string
====================
.. include_body
:ref:`MPI_Add_error_string` |mdash| Associates a string with an error code or class
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Add_error_string(int errorcode, const char *string)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_ADD_ERROR_STRING(ERRORCODE, STRING, IERROR)
INTEGER ERRORCODE, IERROR
CHARACTER*(*) STRING
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Add_error_string(errorcode, string, ierror)
INTEGER, INTENT(IN) :: errorcode
CHARACTER(LEN=*), INTENT(IN) :: string
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT PARAMETERS
----------------
* ``errorcode``: MPI error class, or an error code returned by an MPI routine (integer).
* ``string``: Text that corresponds to the error code or class (string).
OUTPUT PARAMETER
----------------
* ``ierror``: Fortran only: Error status (integer).
DESCRIPTION
-----------
This routine associates an error string with an error code or class.
Calling :ref:`MPI_Add_error_string` for an error code or class that already has
an associated error string will replace the old string with the new one.
It is erroneous to call :ref:`MPI_Add_error_string` for an error value not
generated via :ref:`MPI_Add_error_class` or :ref:`MPI_Add_error_code` (e.g., an error
code or class with a value not greater than MPI_LAST_ERRCODE).
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Add_error_class`
* :ref:`MPI_Add_error_code`
* :ref:`MPI_Error_class`
* :ref:`MPI_Error_string`
|
