MPIStatussetcancelled(3OpenMPI) MPIStatussetcancelled(3OpenMPI)

NAME
       MMPPIISSttaattuusssseettccaanncceelllleedd  -  Sets status to indicate a request has been
       canceled.


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


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


CC++++ SSyynnttaaxx
       #include 
       void MPI::Status::Setcancelled(bool flag)


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       status    Status with which to associate cancel flag (status).


IINNPPUUTT PPAARRAAMMEETTEERR
       flag      If true, indicates request was canceled (logical).


OOUUTTPPUUTT PPAARRAAMMEETTEERR
       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       If flag is set  to  true,  then  a  subsequent  call  to  MPITestcan-
       celled(status,  flag)  will  also return flag = true; otherwise it will
       return false.


NNOOTTEESS
       Users are advised not to reuse the status fields for values other  than
       those  for  which  they  were intended. Doing so may lead to unexpected
       results when using the status object. For example, calling MPIGetele-
       ments  may  cause  an  error if the value is out of range, or it may be
       impossible to detect such an error. The extrastate  argument  provided
       with  a generalized request can be used to return information that does
       not logically belong in status. Furthermore, modifying the values in  a
       status  set  internally  by  MPI,  such as MPIRecv, may lead to unpre-
       dictable results and is strongly discouraged.


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 200M6PIStatussetcancelled(3OpenMPI)