mpi_comm_free_keyval(3openmpi) [osx man page]
MPI_Comm_free_keyval(3OpenMPI) MPI_Comm_free_keyval(3OpenMPI) NAME
MPI_Comm_free_keyval - Frees attribute key for communicator cache attribute. SYNTAX
C Syntax #include <mpi.h> int MPI_Comm_free_keyval(int *comm_keyval) Fortran Syntax INCLUDE 'mpif.h' MPI_COMM_FREE_KEYVAL(COMM_KEYVAL, IERROR) INTEGER COMM_KEYVAL, IERROR C++ Syntax #include <mpi.h> static void MPI::Comm::Free_keyval(int& comm_keyval) INPUT
/OUTPUT PARAMETER comm_keyval OUTPUT PARAMETER
IERROR Fortran only: Error status (integer). DESCRIPTION
MPI_Comm_free_keyval frees an extant attribute key. This function sets the value of keyval to MPI_KEYVAL_INVALID. Note that it is not erroneous to free an attribute key that is in use, because the actual free does not transpire until after all references (in other communi- cators on the process) to the key have been freed. These references need to be explictly freed by the program, either via calls to MPI_Comm_delete_attr that free one attribute instance, or by calls to MPI_Comm_free that free all attribute instances associated with the freed communicator. This call is identical to the call MPI_Keyval_free but is needed to match the communicator-specific creation function introduced in the MPI-2 standard. The use of MPI_Keyval_free is deprecated. NOTES
Key values are global (they can be used with any and all communicators). 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. Open MPI 1.2 September 2006 MPI_Comm_free_keyval(3OpenMPI)
Check Out this Related Man Page
MPI_Comm_free_keyval(3) LAM/MPI MPI_Comm_free_keyval(3) NAME
MPI_Comm_free_keyval - Free communicator attribute key SYNOPSIS
#include <mpi.h> int MPI_Comm_free_keyval(int *key) INPUT PARAMETER
key - Key value USAGE WITH IMPI EXTENSIONS
The IMPI standard only supports MPI-1 functions. Hence, this function is currently not designed to operate within an IMPI job. NOTES FOR FORTRAN
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list. ierr is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the call statement. All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran. ERRORS
If an error occurs in an MPI function, the current MPI error handler is called to handle it. By default, this error handler aborts the MPI job. The error handler may be changed with MPI_Errhandler_set ; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned (in C and Fortran; this error handler is less useful in with the C++ MPI bindings. The predefined error handler MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value needs to be recovered). Note that MPI does not guarantee that an MPI program can continue past an error. 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 last argument. The C++ bindings for MPI do not return error values; instead, error values are communicated by throwing exceptions of type MPI::Exception (but not by default). Exceptions are only thrown if the error value is not MPI::SUCCESS . Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return upon an error, there will be no way to recover what the actual error value was. MPI_SUCCESS - No error; MPI routine completed successfully. MPI_ERR_OTHER - Other error; the error code associated with this error indicates an attempt to use an invalue keyval. MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class. This is typically a NULL pointer or other such error. SEE ALSO
MPI_Comm_create_keyval(3), MPI_Comm_set_attr(3), MPI_Comm_get_attr(3), MPI_Comm_delete_attr(3) MORE INFORMATION
For more information, please see the official MPI Forum web site, which contains the text of both the MPI-1 and MPI-2 standards. These documents contain detailed information about each MPI function (most of which is not duplicated in these man pages). http://www.mpi-forum.org/ LOCATION
cfreekey.c LAM
/MPI 6.5.8 11/10/2002 MPI_Comm_free_keyval(3)