MPIWinstart(3OpenMPI) MPIWinstart(3OpenMPI)

NAME
       MMPPIIWWiinnssttaarrtt - Starts an RMA access epoch for win


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIWinstart(MPIGroup group, int assert, MPIWin win)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIWINSTART(GROUP, ASSERT, WIN, IERROR)
            INTEGER GROUP, ASSERT, WIN, IERROR


CC++++ SSyynnttaaxx
       #include 
       void MPI::Win::Start(const MPI::Group& group, int assert) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       group     The group of target processes (handle).

       assert    Program assertion (integer).

       win       Window object (handle).


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


DESCRIPTION
       MPIWinstart  is  a  one-sided  MPI communication synchronization call
       that starts an RMA access epoch for win. RMA calls issued on win during
       this epoch must access only windows at processes in group. Each process
       in group must issue a matching call to MPIWinpost.  MPIWinstart  is
       allowed  to  block until the corresponding MPIWinpost calls have been
       executed, but is not required to.

       The assert argument is used to provide assertions on the context of the
       call  that may be used for various optimizations. (See Section 6.4.4 of
       the MPI-2 Standard.) A value of assert = 0 is always valid. The follow-
       ing assertion value is supported:


       MPIMODENOCHECK
                 When  this  value  is  passed  in  to  this call, the library
                 assumes that the post call on the target has been called  and
                 it is not necessary for the library to check to see if such a
                 call has been made.


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
       MPIWinseterrhandler;  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
       MPIWinpost MPIWincomplete




Open MPI 1.2                      March 2007           MPIWinstart(3OpenMPI)