This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

MPI_Win_get_attr(3OpenMPI)                                                        MPI_Win_get_attr(3OpenMPI)



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)
       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


C++ Syntax
       #include <mpi.h>
       bool MPI::Win::Get_attr(int win_keyval, void* attribute_val) const


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. C++ functions do not return errors. If the default  error  handler  is
       set  to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw
       an MPI:Exception object.

       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.




Open MPI 1.2                                   September 2006                     MPI_Win_get_attr(3OpenMPI)