NAME

MPI_Type_free - Frees a data type

SYNOPSIS

#include <mpi.h> 
int MPI_Type_free(MPI_Datatype *datatype ); 
#include <pmpi.h> 
int PMPI_Type_free(MPI_Datatype *datatype ); 

INPUT PARAMETER

datatype - type (handle)

OUTPUT PARAMETER

datatype - the type is set to MPI_DATATYPE_NULL

DESCRIPTION

The MPI_Type_free() function is used to free a user-created data type datatype . You may not free any of the predefined MPI data types.

PMPI_Type_free() is the profiling version of this function.

On success, datatype is set to MPI_DATATYPE_NULL

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_ERR_TYPE - Invalid type.

SEE ALSO

MPI_Type_commit (3) MPI_Type_struct (3) MPI_Type_create_struct (3) MPI_Type_contiguous (3) MPI_Type_indexed (3) MPI_Type_hindexed (3) MPI_Type_create_hindexed (3) MPI_Type_vector (3) MPI_Type_hvector (3) MPI_Type_create_hvector (3)

• Lockless
• MPI Documentation
• MPI_Type_free