MPIRecvinit(3OpenMPI) MPIRecvinit(3OpenMPI)

NAME
       MMPPIIRReeccvviinniitt - Builds a handle for a receive.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIRecvinit(void *buf, int count, MPIDatatype datatype,
            int source, int tag, MPIComm comm, MPIRequest *request)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIRECVINIT(BUF, COUNT, DATATYPE, SOURCE, TAG, COMM, REQUEST,
                 IERROR)
                BUF(*)
            INTEGER   COUNT, DATATYPE, SOURCE, TAG, COMM, REQUEST, IERROR


CC++++ SSyynnttaaxx
       #include 
       Prequest Comm::Recvinit(void* buf, int count, const
            Datatype& datatype, int source, int tag) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       count     Maximum number of elements to receive (integer).

       datatype  Type of each entry (handle).

       source    Rank of source (integer).

       tag       Message tag (integer).

       comm      Communicator (handle).


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       buf       Initial address of receive buffer (choice).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       request   Communication request (handle).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Creates a persistent communication request for a receive operation. The
       argument buf is marked as OUT because  the  user  gives  permission  to
       write on the receive buffer by passing the argument to MPIRecvinit.

       A  persistent  communication request is inactive after it is created -
       no active communication is attached to the request.

       A communication (send or receive) that uses  a  persistent  request  is
       initiated by the function MPIStart or MPIStartall.


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.


SEE ALSO
       MPIBsendinit
       MPIRsendinit
       MPISendinit
       MPISssendinit
       MPIStart
       MPIStartall
       MPIRequestfree




Open MPI 1.2                    September 2006         MPIRecvinit(3OpenMPI)