MPIRequestgetstatus(3OpenMPI) MPIRequestgetstatus(3OpenMPI)

NAME
       MMPPIIRReeqquueessttggeettssttaattuuss  -  Access information associated with a request
       without freeing the request.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIRequestgetstatus(MPIRequest request, int *flag, MPIStatus *status)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIREQUESTFREE(REQUEST, FLAG, STATUS, IERROR)
            INTEGER   REQUEST, STATUS(MPISTATUSSIZE), IERROR
            LOGICAL   FLAG


CC++++ SSyynnttaaxx
       #include 
       bool MPI::Request::Getstatus(MPI::Status& status) const

       bool MPI::Request::Getstatus() const


IINNPPUUTT PPAARRAAMMEETTEERR
       rreeqquueesstt         Communication request (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       ffllaagg      Boolean flag, same as from MPITest (logical).

       ssttaattuuss    MPIStatus object if flag is true (status).


DESCRIPTION
       MPIRequestgetstatus sets flag=true if the operation is  complete  or
       sets flag=false if it is not complete. If the operation is complete, it
       returns in status the request status. It does not deallocate or inacti-
       vate  the  request;  a subsequent call to test, wait, or free should be
       executed with that request.

       If your application does not need to examine the status field, you  can
       save  resources by using the predefined constant MPISTATUSIGNORE as a
       special value for the status argument.


EERRRROORRSS
       Almost all MPI routines return an error value; C routines as the  value
       of  the  function  and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default  error  handler  is  set  to
       MPI::ERRORSTHROWEXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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.




Open MPI 1.2                    September 2006MPIRequestgetstatus(3OpenMPI)