MPI_Keyval_free
Frees attribute key for communicator cache attribute
Synopsis
#include "mpi.h"
int MPI_Keyval_free ( keyval )
int *keyval;
Input Parameter
- keyval
- Frees the integer key value (integer)
Note
Key values are global (they can be used with any and all communicators)
Notes for Fortran
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK)
havean additional argument ierr at the end of the argument list.
ierris an integer and has the same meaning as the return value of the
routinein C. In Fortran, MPI routines are subroutines, and are invoked with
thecall statement.
All MPI objects (e.g., MPI_Datatype, MPI_Comm) are of type
INTEGERin Fortran.
Errors
All MPI routines (except MPI_Wtime and MPI_Wtick) return an error value;
C routines as the value of the function and Fortran routines in the
lastargument. Before the value is returned, the current MPI error handler
iscalled. By default, this error handler aborts the MPI job. The error
handlermay be changed with MPI_Errhandler_set; the predefined error
handlerMPI_ERRORS_RETURN may be used to cause error values to be returned.
Note that MPI does not guarentee that an MPI program can continue
pastan error.
- MPI_SUCCESS
- No error; MPI routine completed successfully.
- MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g., MPI_ERR_RANK).
- MPI_ERR_ARG
- This error class is associated with an error code that
indicates that an attempt was made to free one of the permanent keys.
See Also
MPI_Keyval_create
Location:keyval_free.c