MPITestcancelled(3OpenMPI) MPITestcancelled(3OpenMPI)

NAME
       MMPPIITTeessttccaanncceelllleedd - Tests whether a request was canceled.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPITestcancelled(MPIStatus *status, int *flag)


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


CC++++ SSyynnttaaxx
       #include 
       bool Status::Iscancelled() const


IINNPPUUTT PPAARRAAMMEETTEERR
       status    Status object (status).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       flag      True if operation was cancelled (logical).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Returns  flag  =  true  if the communication associated with the status
       object was canceled successfully. In such a case, all other  fields  of
       status  (such as count or tag) are undefined. Otherwise, returns flag =
       false. If a receive  operation  might  be  canceled,  one  should  call
       MPITestcancelled  first, to check whether the operation was canceled,
       before checking on the other fields of the return status.


NNOOTTEESS
       Cancel can be an expensive operation that should be  used  only  excep-
       tionally.


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 2006    MPITestcancelled(3OpenMPI)