.\"Copyright 2006-2008 Sun Microsystems, Inc. .\"Copyright (c) 1996 Thinking Machines .TH MPI_Type_free_keyval 3 "Dec 08, 2009" "1.4" "Open MPI" .SH NAME \fBMPI_Type_free_keyval\fP \- Frees a previously created type key value. .SH SYNTAX .ft R .SH C Syntax .nf #include int MPI_Type_free_keyval(int *\fItype_keyval\fP) .SH Fortran Syntax .nf INCLUDE 'mpif.h' MPI_TYPE_FREE_KEYVAL(\fITYPE_KEYVAL, IERROR\fP) INTEGER \fITYPE_KEYVAL, IERROR \fP .SH C++ Syntax .nf #include static void MPI::Datatype::Free_keyval(int& \fItype_keyval\fP) .SH INPUT/OUTPUT PARAMETER .ft R .TP 1i type_keyval Key value to free (integer). .SH OUTPUT PARAMETER .ft R .TP 1i IERROR Fortran only: Error status (integer). .SH DESCRIPTION .ft R .SH 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++ functions 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. .sp 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. .SH SEE ALSO .ft R .sp MPI_Type_create_keyval .br