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
|
.. _mpi_win_get_info:
MPI_Win_get_info
================
.. include_body
:ref:`MPI_Win_get_info` |mdash| Retrieves active window info hints
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Win_get_info(MPI_Win win, MPI_Info *info_used)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_WIN_GET_INFO(WIN, INFO_USED, IERROR)
INTEGER WIN, INFO_USED, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Win_get_info(win, info_used, ierror)
TYPE(MPI_Win), INTENT(IN) :: win
TYPE(MPI_Info), INTENT(OUT) :: info_used
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT PARAMETERS
----------------
* ``win``: Window from which to receive active info hints
OUTPUT PARAMETERS
-----------------
* ``info_used``: New info object returned with all active hints on this window.
* ``ierror``: Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Win_get_info` returns a new info object containing the hints of the
window associated with *win*. The current setting of all hints actually
used by the system related to this window is returned in *info_used*. If
no such hints exist, a handle to a newly created info object is returned
that contains no key/value pair. The user is responsible for freeing
info_used via :ref:`MPI_Info_free`.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Win_set_info`
* :ref:`MPI_Win_free`
|