Open MPI logo

MPI_Win_get_attr(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

MPI_Win_get_attr - Obtains the value of a window attribute.

Syntax

C Syntax


#include <mpi.h>
int MPI_Win_get_attr(MPI_Win win, int win_keyval,
    void *attribute_val, int *flag)

Fortran Syntax (see FORTRAN 77 NOTES)


USE MPI
! or the older form: INCLUDE ’mpif.h’
MPI_WIN_GET_ATTR(WIN, WIN_KEYVAL, ATTRIBUTE_VAL, FLAG, IERROR)
    INTEGER WIN, WIN_KEYVAL, IERROR
    INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE_VAL
    LOGICAL FLAG

Fortran 2008 Syntax


USE mpi_f08
MPI_Win_get_attr(win, win_keyval, attribute_val, flag, ierror)
    TYPE(MPI_Win), INTENT(IN) :: win
    INTEGER, INTENT(IN) :: win_keyval
    INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(OUT) :: attribute_val
    LOGICAL, INTENT(OUT) :: flag
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

Input Parameters

win
Window to which the attribute is attached (handle).
win_keyval
Key value (integer).

Output Parameters

attribute_val
Attribute value, unless ag = false
flag
False if no attribute is associated with the key (logical).
IERROR
Fortran only: Error status (integer).

Description

Obtains the value of a window attribute.

Fortran 77 Notes

The MPI standard prescribes portable Fortran syntax for the ATTRIBUTE_VAL argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax


     INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL

where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the length of the declared integer in bytes.

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.


Table of Contents

« Return to documentation listing