[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Request_get_status 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Request_get_status\fP \- Access information associated with a request without freeing the request. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .SH C Syntax |
---|
| 10 | .nf |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_Request_get_status(MPI_Request \fIrequest\fP, int \fI*flag\fP, MPI_Status \fI*status\fP) |
---|
| 13 | |
---|
| 14 | .SH Fortran Syntax |
---|
| 15 | .nf |
---|
| 16 | INCLUDE 'mpif.h' |
---|
| 17 | MPI_REQUEST_FREE(\fIREQUEST\fP, \fIFLAG\fP, \fISTATUS\fP, \fIIERROR\fP) |
---|
| 18 | INTEGER REQUEST, STATUS(MPI_STATUS_SIZE), IERROR |
---|
| 19 | LOGICAL FLAG |
---|
| 20 | |
---|
| 21 | .SH C++ Syntax |
---|
| 22 | .nf |
---|
| 23 | #include <mpi.h> |
---|
| 24 | bool MPI::Request::Get_status(MPI::Status& \fIstatus\fP) const |
---|
| 25 | |
---|
| 26 | bool MPI::Request::Get_status() const |
---|
| 27 | |
---|
| 28 | .SH INPUT PARAMETER |
---|
| 29 | .ft |
---|
| 30 | .TP 1i |
---|
| 31 | request |
---|
| 32 | Communication request (handle). |
---|
| 33 | |
---|
| 34 | .SH OUTPUT PARAMETERS |
---|
| 35 | .ft |
---|
| 36 | .TP 1i |
---|
| 37 | flag |
---|
| 38 | Boolean flag, same as from MPI_Test (logical). |
---|
| 39 | .ft |
---|
| 40 | .TP 1i |
---|
| 41 | status |
---|
| 42 | MPI_Status object if flag is true (status). |
---|
| 43 | |
---|
| 44 | .SH DESCRIPTION |
---|
| 45 | .ft R |
---|
| 46 | MPI_Request_get_status sets \fIflag\fP=\fItrue\fP if the operation is complete or sets \fIflag\fP=\fIfalse\fP if it is not complete. If the operation is complete, it returns in \fIstatus\fP the request status. It does not deallocate or inactivate the request; a subsequent call to test, wait, or free should be executed with that request. |
---|
| 47 | .sp |
---|
| 48 | If your application does not need to examine the \fIstatus\fP field, you can save resources by using the predefined constant MPI_STATUS_IGNORE as a special value for the \fIstatus\fP argument. |
---|
| 49 | |
---|
| 50 | .SH ERRORS |
---|
| 51 | 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. |
---|
| 52 | .sp |
---|
| 53 | Before the error value is returned, the current MPI error handler is |
---|
| 54 | 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. |
---|
| 55 | |
---|