NAME

MPI_Keyval_free - Frees a key value

SYNOPSIS

#include <mpi.h> 
int MPI_Keyval_free(int *keyval ); 
#include <pmpi.h> 
int PMPI_Keyval_free(int *keyval ); 
INCLUDE 'mpif.h' 
MPI_KEYVAL_FREE(keyval , ierr ) 
INTEGER  keyval ,  ierr 

INPUT PARAMETER

keyval - key value (handle)

OUTPUT PARAMETER

keyval - the keyval is set to MPI_KEYVAL_INVALID

DESCRIPTION

The MPI_Keyval_free() function is used to free a user-created keyval . The keyval must be a valid one, i.e. not MPI_KEYVAL_INVALID.

PMPI_Keyval_free() is the profiling version of this function.

On success, keyval is set to MPI_KEYVAL_INVALID

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the 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.

In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.

MPI_SUCCESS - No error;

MPI_ERR_PENDING - Pending exception;

MPI_SUCCESS - No error;

MPI_ERR_KEYVAL - Invalid keyval.

SEE ALSO

MPI_Keyval_create (3) MPI_Attr_put (3) MPI_Attr_get (3) MPI_Attr_delete (3)

• Lockless
• MPI Documentation
• MPI_Keyval_free