dwww Home | Manual pages | Find package

MPI_Win_get_info(3)                Open MPI                MPI_Win_get_info(3)

NAME
       MPI_Win_get_info - 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   COMM, 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 win-
                 dow.

       IERROR    Fortran only: Error status (integer).

DESCRIPTION
       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 re-
       turned that contains no key/value pair. The  user  is  responsible  for
       freeing info_used via MPI_Info_free.

ERRORS
       Almost  all MPI routines return an error value; C routines as the value
       of the function and Fortran routines in the last argument.

       Before the error value is returned, the current MPI  error  handler  is
       called.  By  default, this error handler aborts the MPI job, except for
       I/O  function  errors.  The  error  handler   may   be   changed   with
       MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN
       may be used to cause error values to be returned. Note  that  MPI  does
       not guarantee that an MPI program can continue past an error.

SEE ALSO
       MPI_Win_set_info, MPI_Win_free

4.1.2                            Nov 24, 2021              MPI_Win_get_info(3)

Generated by dwww version 1.14 on Fri Jan 24 06:33:06 CET 2025.