MPIKeyvalfree(3OpenMPI) MPIKeyvalfree(3OpenMPI)

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


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIKeyvalfree(int *keyval)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIKEYVALFREE(KEYVAL, IERROR)
            INTEGER   KEYVAL, IERROR



IINNPPUUTT PPAARRAAMMEETTEERR
       keyval    Frees the integer key value (integer).


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


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

       This deprecated routine is not available in C++.

       Frees  an  extant attribute key. This function sets the value of keyval
       to  MPIKEYVALINVALID. Note that  it  is  not  erroneous  to  free  an
       attribute  key  that  is in use, because the actual free does not tran-
       spire 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  MPIAttrdelete
       that  free  one  attribute  instance, or by calls to MPICommfree that
       free all attribute instances associated with the freed communicator.


NNOOTTEE
       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.


SEE ALSO
       MPIKeyvalcreate








Open MPI 1.2                    September 2006       MPIKeyvalfree(3OpenMPI)