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