MPICommfree(3OpenMPI) MPICommfree(3OpenMPI)

NAME
       MMPPIICCoommmmffrreeee  - Mark a communicator object for deallocation.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICommfree(MPIComm *comm)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPICOMMFREE(COMM, IERROR)
            INTEGER   COMM, IERROR


CC++++ SSyynnttaaxx
       #include 
       void Comm::Free()


IINNPPUUTT PPAARRAAMMEETTEERR
       comm      Communicator to be destroyed (handle).


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


DESCRIPTION
       This operation marks the communicator object for deallocation. The han-
       dle is set to MPICOMMNULL. Any pending operations that use this  com-
       municator  will  complete  normally; the object is actually deallocated
       only if there are no other active references to it. This  call  applies
       to intracommunicators and intercommunicators. Upon actual deallocation,
       the delete callback functions for all cached  attributes  (see  Section
       5.7 in the MPI-1 Standard, "Caching") are called in arbitrary order.


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