MPICommfreekeyval(3OpenMPI) MPICommfreekeyval(3OpenMPI)

NAME
       MMPPIICCoommmmffrreeeekkeeyyvvaall  -  Frees  attribute  key  for  communicator cache
       attribute.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICommfreekeyval(int *commkeyval)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPICOMMFREEKEYVAL(COMMKEYVAL, IERROR)
            INTEGER   COMMKEYVAL, IERROR


CC++++ SSyynnttaaxx
       #include 
       static void MPI::Comm::Freekeyval(int& commkeyval)


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       commkeyval


OOUUTTPPUUTT PPAARRAAMMEETTEERR
       IERROR    Fortran only: Error status (integer).



DESCRIPTION
       MPICommfreekeyval frees an extant attribute key. This function  sets
       the  value  of keyval to  MPIKEYVALINVALID. Note that it is not erro-
       neous 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
       MPICommdeleteattr that free one attribute instance, or by  calls  to
       MPICommfree  that  free  all  attribute instances associated with the
       freed communicator.

       This call is identical to the call MPIKeyvalfree  but  is  needed  to
       match  the   communicator-specific  creation function introduced in the
       MPI-2 standard. The use of MPIKeyvalfree is deprecated.



NNOOTTEESS
       Key values are global (they can be used with  any  and  all  communica-
       tors).


EERRRROORRSS
       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::ERRORSTHROWEXCEPTIONS, 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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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  MPICommfreekeyval(3OpenMPI)