Rev | Line | |
---|
[97] | 1 | .\"Copyright 2007-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Win_free 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Win_free\fP \- Frees the window object and returns a null handle. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .SH C Syntax |
---|
| 10 | .nf |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_Win_free(MPI_Win *\fIwin\fP) |
---|
| 13 | |
---|
| 14 | .SH Fortran Syntax |
---|
| 15 | .nf |
---|
| 16 | INCLUDE 'mpif.h' |
---|
| 17 | MPI_WIN_FREE(\fIWIN, IERROR\fP) |
---|
| 18 | INTEGER \fIWIN, IERROR\fP |
---|
| 19 | |
---|
| 20 | .SH C++ Syntax |
---|
| 21 | .nf |
---|
| 22 | #include <mpi.h> |
---|
| 23 | void MPI::Win::Free() |
---|
| 24 | |
---|
| 25 | .SH INPUT/OUTPUT PARAMETER |
---|
| 26 | .ft R |
---|
| 27 | .TP 1i |
---|
| 28 | win |
---|
| 29 | Window object (handle). |
---|
| 30 | |
---|
| 31 | .SH OUTPUT PARAMETER |
---|
| 32 | .ft R |
---|
| 33 | .TP 1i |
---|
| 34 | IERROR |
---|
| 35 | Fortran only: Error status (integer). |
---|
| 36 | |
---|
| 37 | .SH DESCRIPTION |
---|
| 38 | .ft R |
---|
| 39 | MPI_Win_free frees the window object \fIwin\fP and returns a null handle (equal to MPI_WIN_NULL). This collective call is executed by all processes in the group associated with \fIwin\fP. It can be invoked by a process only after it has completed its involvement in RMA communications on window \fIwin\fP, that is, the process has called MPI_Win_fence, or called MPI_Win_unlock to match a previous call to MPI_Win_lock. When the call returns, the window memory can be freed. |
---|
| 40 | |
---|
| 41 | .SH ERRORS |
---|
| 42 | 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. |
---|
| 43 | .sp |
---|
| 44 | Before the error value is returned, the current MPI error handler is |
---|
| 45 | 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. |
---|
| 46 | |
---|
| 47 | .SH SEE ALSO |
---|
| 48 | MPI_Win_create |
---|
| 49 | MPI_Win_fence |
---|
| 50 | MPI_Win_unlock |
---|
| 51 | .br |
---|
| 52 | |
---|
Note: See
TracBrowser
for help on using the repository browser.