Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 1.49 KB

MPI_Win_get_info.3.rst

File metadata and controls

76 lines (48 loc) · 1.49 KB

MPI_Win_get_info

:ref:`MPI_Win_get_info` |mdash| Retrieves active window info hints

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Win_get_info(MPI_Win win, MPI_Info *info_used)

Fortran Syntax

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

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

.. seealso::
   * :ref:`MPI_Win_set_info`
   * :ref:`MPI_Win_free`