MPIWinfree(3OpenMPI) MPIWinfree(3OpenMPI)

NAME
       MMPPIIWWiinnffrreeee - Frees the window object and returns a null handle.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIWinfree(MPIWin *win)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIWINFREE(WIN, IERROR)
            INTEGER WIN, IERROR


CC++++ SSyynnttaaxx
       #include 
       void MPI::Win::Free()


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       win       Window object (handle).


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


DESCRIPTION
       MPIWinfree  frees  the  window  object  win and returns a null handle
       (equal to MPIWINNULL). This collective call is executed by  all  pro-
       cesses in the group associated with win. It can be invoked by a process
       only after it has completed its involvement in  RMA  communications  on
       window  win,  that  is, the process has called MPIWinfence, or called
       MPIWinunlock to match a previous call to MPIWinlock. When the  call
       returns, the window memory can be freed.


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
       MPIWincreate MPIWinfence MPIWinunlock




Open MPI 1.2                      March 2006            MPIWinfree(3OpenMPI)