MPITypefree(3OpenMPI) MPITypefree(3OpenMPI)

NAME
       MMPPIITTyyppeeffrreeee - Frees a data type.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPITypefree(MPIDdatatype *datatype)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPITYPEFREE(DATATYPE, IERROR)
            INTEGER   DATATYPE, IERROR


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


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       datatype  Datatype that is freed (handle).


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


DESCRIPTION
       Marks  the  datatype  object associated with datatype for de-allocation
       and sets datatype to MPIDATATYPENULL. Any communication that is  cur-
       rently  using  this  datatype will complete normally. Derived datatypes
       that were defined from the freed datatype are not affected.

       Freeing a datatype does not affect any other datatype  that  was  built
       from  the freed datatype. The system behaves as if input datatype argu-
       ments to derived datatype constructors are passed by value.


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