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 94
|
.. _mpi_win_create_errhandler:
MPI_Win_create_errhandler
=========================
.. include_body
:ref:`MPI_Win_create_errhandler` |mdash| Creates an error handler for a window.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Win_create_errhandler(MPI_Win_errhandler_function *function,
MPI_Errhandler *errhandler)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_WIN_CREATE_ERRHANDLER(FUNCTION, ERRHANDLER, IERROR)
EXTERNAL FUNCTION
INTEGER ERRHANDLER, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Win_create_errhandler(win_errhandler_fn, errhandler, ierror)
PROCEDURE(MPI_Win_errhandler_function) :: win_errhandler_fn
TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
DEPRECATED TYPE NAME NOTE
-------------------------
MPI-2.2 deprecated the ``MPI_Win_errhandler_fn`` type in favor of
``MPI_Win_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_Win_create_errhandler` should be, in C, a function of type
``MPI_Win_errhandler_function``, which is defined as
.. code-block:: c
typedef void MPI_Win_errhandler_function(MPI Win *, int *, ...);
The first argument is the window in use, the second is the error code to
be returned.
In Fortran, the user routine should be of the form:
.. code-block:: fortran
SUBROUTINE WIN_ERRHANDLER_FUNCTION(WIN, ERROR_CODE, ...)
INTEGER WIN, ERROR_CODE
ERRORS
------
.. include:: ./ERRORS.rst
|