1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Win_get_attr 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Win_get_attr\fP \- Obtains the value of a window attribute. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Win_get_attr(MPI_Win \fIwin\fP, int \fIwin_keyval\fP, |
---|
13 | void *\fIattribute_val\fP, int *\fIflag\fP) |
---|
14 | |
---|
15 | .SH Fortran Syntax (see FORTRAN 77 NOTES) |
---|
16 | .nf |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_WIN_GET_ATTR(\fIWIN, WIN_KEYVAL, ATTRIBUTE_VAL, FLAG, IERROR\fP) |
---|
19 | INTEGER \fIWIN, WIN_KEYVAL, IERROR\fP |
---|
20 | INTEGER(KIND=MPI_ADDRESS_KIND) \fIATTRIBUTE_VAL\fP |
---|
21 | LOGICAL \fIFLAG\fP |
---|
22 | |
---|
23 | .SH C++ Syntax |
---|
24 | .nf |
---|
25 | #include <mpi.h> |
---|
26 | bool MPI::Win::Get_attr(int win_keyval, void* attribute_val) const |
---|
27 | |
---|
28 | .SH INPUT PARAMETERS |
---|
29 | .ft R |
---|
30 | .TP 1i |
---|
31 | win |
---|
32 | Window to which the attribute is attached (handle). |
---|
33 | .TP 1i |
---|
34 | win_keyval |
---|
35 | Key value (integer). |
---|
36 | |
---|
37 | .SH OUTPUT PARAMETERS |
---|
38 | .ft R |
---|
39 | .TP 1i |
---|
40 | attribute_val |
---|
41 | Attribute value, unless \fIag\fP = false |
---|
42 | .TP 1i |
---|
43 | flag |
---|
44 | False if no attribute is associated with the key (logical). |
---|
45 | .TP 1i |
---|
46 | IERROR |
---|
47 | Fortran only: Error status (integer). |
---|
48 | |
---|
49 | .SH DESCRIPTION |
---|
50 | .ft R |
---|
51 | Obtains the value of a window attribute. |
---|
52 | .SH FORTRAN 77 NOTES |
---|
53 | .ft R |
---|
54 | The MPI standard prescribes portable Fortran syntax for |
---|
55 | the \fIATTRIBUTE_VAL\fP argument only for Fortran 90. FORTRAN 77 |
---|
56 | users may use the non-portable syntax |
---|
57 | .sp |
---|
58 | .nf |
---|
59 | INTEGER*MPI_ADDRESS_KIND \fIATTRIBUTE_VAL\fP |
---|
60 | .fi |
---|
61 | .sp |
---|
62 | where MPI_ADDRESS_KIND is a constant defined in mpif.h |
---|
63 | and gives the length of the declared integer in bytes. |
---|
64 | |
---|
65 | .SH ERRORS |
---|
66 | 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. |
---|
67 | .sp |
---|
68 | Before the error value is returned, the current MPI error handler is |
---|
69 | 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. |
---|
70 | |
---|