openmpi/ompi/mpi/man/man3/MPI_Win_get_attr.3

.\"Copyright 2006, Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.TH MPI_Win_get_attr 3OpenMPI "September 2006" "Open MPI 1.2" " "
.SH NAME
\fBMPI_Win_get_attr\fP \- Obtains the value of a window attribute.

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Win_get_attr(MPI_Win \fIwin\fP, int \fIwin_keyval\fP, 
	void *\fIattribute_val\fP, int *\fIflag\fP) 

.SH Fortran Syntax (see FORTRAN 77 NOTES)
.nf
INCLUDE 'mpif.h'
MPI_WIN_GET_ATTR(\fIWIN, WIN_KEYVAL, ATTRIBUTE_VAL, FLAG, IERROR\fP) 
	INTEGER \fIWIN, WIN_KEYVAL, IERROR\fP 
	INTEGER(KIND=MPI_ADDRESS_KIND) \fIATTRIBUTE_VAL\fP 
	LOGICAL \fIFLAG\fP 

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

.SH INPUT PARAMETERS
.ft R
.TP 1i
win
Window to which the attribute is attached (handle). 
.TP 1i
win_keyval
Key value (integer).

.SH OUTPUT PARAMETERS
.ft R
.TP 1i
attribute_val
Attribute value, unless \fIag\fP = false
.TP 1i
flag
False if no attribute is associated with the key (logical). 
.TP 1i
IERROR
Fortran only: Error status (integer). 

.SH DESCRIPTION
.ft R
Obtains the value of a window attribute.
.SH FORTRAN 77 NOTES
.ft R
The MPI standard prescribes portable Fortran syntax for
the \fIATTRIBUTE_VAL\fP argument only for Fortran 90. FORTRAN 77
users may use the non-portable syntax
.sp
.nf
     INTEGER*MPI_ADDRESS_KIND \fIATTRIBUTE_VAL\fP 
.fi
.sp
where MPI_ADDRESS_KIND is a constant defined in mpif.h
and gives the length of the declared integer in bytes.

.SH 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.
.sp
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.