MPIStatussetelements(3OpenMPI) MPIStatussetelements(3OpenMPI)

NAME
       MMPPIISSttaattuusssseetteelleemmeennttss  -  Modifies  opaque  part  of  status to allow
       MPIGetelements to return count.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIStatussetelements(MPIStatus *status, MPIDatatype datatype, int count)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPISTATUSSETELEMENTS(STATUS, DATATYPE, COUNT, IERROR)
            INTEGER   STATUS(MPISTATUSSIZE), DATATYPE, COUNT, IERROR


CC++++ SSyynnttaaxx
       #include 
       void MPI::Status::Setelements(const MPI::Datatype& datatype, int count)


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       status    Status to associate with count (status).


IINNPPUUTT PPAARRAAMMEETTEERRSS
       datatype  Data type associated with count (handle).

       count     Number of elements to associate with status (integer).


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


DESCRIPTION
       MPIStatussetelements modifies the opaque part of status  so  that  a
       call to MPIGetelements will return count. MPIGetcount will return a
       compatible value.

       A subsequent call  to  MPIGetcount(status,  datatype,  count)  or  to
       MPIGetelements(status, datatype, count) must use a data-type argument
       that has the same type signature as the  data-type  argument  that  was
       used in the call to MPIStatussetelements.


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