MPIGroupfree(3OpenMPI) MPIGroupfree(3OpenMPI)

NAME
       MMPPIIGGrroouuppffrreeee  - Frees a group.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIGroupfree(MPIGroup *group)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIGROUPFREE(GROUP, IERROR)
            INTEGER   GROUP, IERROR


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


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       group     Group (handle).


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


DESCRIPTION
       This  operation marks a group object for deallocation. The handle group
       is set to MPIGROUPNULL by the call. Any ongoing operation using  this
       group will complete normally.


NNOOTTEE
       On return, group is set to MPIGROUPNULL.


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