mpi_keyval_free(3openmpi) [osx man page]

MPI_Keyval_free(3OpenMPI)												 MPI_Keyval_free(3OpenMPI)

NAME

       MPI_Keyval_free - Frees attribute key for communicator cache attribute -- use of this routine is deprecated.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Keyval_free(int *keyval)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_KEYVAL_FREE(KEYVAL, IERROR)
	    INTEGER   KEYVAL, IERROR

INPUT PARAMETER

       keyval	 Frees the integer key value (integer).

OUTPUT PARAMETER

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       Note that use of this routine is deprecated as of MPI-2. Please use MPI_Comm_free_keyval instead.

       This deprecated routine is not available in C++.

       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 communicators on the process)
       to  the	key have been freed. These references need to be explictly freed by the program, either via calls to MPI_Attr_delete that free one
       attribute instance, or by calls to MPI_Comm_free that free all attribute instances associated with the freed communicator.

NOTE

       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.

SEE ALSO

       MPI_Keyval_create

Open MPI 1.2							  September 2006					 MPI_Keyval_free(3OpenMPI)

MPI_Keyval_free(3)							MPI							MPI_Keyval_free(3)

NAME

       MPI_Keyval_free -  Frees an attribute key for communicators

SYNOPSIS

       int MPI_Keyval_free(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)

DEPRECATED FUNCTION

       The  MPI-2  standard  deprecated a number of routines because MPI-2 provides better versions.  This routine is one of those that was depre-
       cated.  The routine may continue to be used, but new code should use  the  replacement  routine.   The  replacement  for  this  routine	is
       MPI_Comm_free_keyval .

THREAD AND INTERRUPT SAFETY

       This  routine  is  thread-safe.	This means that this routine may be safely used by multiple threads without the need for any user-provided
       thread locks.  However, the routine is not interrupt safe.  Typically, this is due to the use of memory allocation routines such as  malloc
       or other non-MPICH runtime routines that are themselves not interrupt-safe.

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

       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.  Before the value is returned, the current MPI error handler is called.  By default, this error handler aborts  the  MPI
       job.   The  error  handler  may	be  changed  with  MPI_Comm_set_errhandler  (for  communicators), MPI_File_set_errhandler (for files), and
       MPI_Win_set_errhandler (for RMA windows).  The MPI-1 routine MPI_Errhandler_set may be used but its  use  is  deprecated.   The	predefined
       error handler MPI_ERRORS_RETURN may be used to cause error values to be returned.  Note that MPI does not guarentee that an MPI program can
       continue past an error; however, MPI implementations will attempt to continue whenever possible.

       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, MPI_Comm_free_keyval

LOCATION

       keyval_free.c

								     7/28/2010							MPI_Keyval_free(3)