Open MPI logo

MPI_Type_free(3) man page (version 1.2.9)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing



NAME

       MPI_Type_free - Frees a data type.

SYNTAX


C Syntax

       #include <mpi.h>
       int MPI_Type_free(MPI_Ddatatype *datatype)

Fortran Syntax

       INCLUDE 'mpif.h'
       MPI_TYPE_FREE(DATATYPE, IERROR)
            INTEGER   DATATYPE, IERROR

C++ Syntax

       #include <mpi.h>
       void Datatype::Free()

INPUT/OUTPUT PARAMETER

       datatype  Datatype that is freed (handle).

OUTPUT PARAMETER

       IERROR    Fortran only: Error status (integer).

DESCRIPTION

       Marks  the  datatype  object associated with datatype for de-allocation
       and sets datatype to MPI_DATATYPE_NULL. 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.

ERRORS

       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::ERRORS_THROW_EXCEPTIONS, 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
       MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN
       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.

« Return to documentation listing