MPICommdeleteattr(3OpenMPI) MPICommdeleteattr(3OpenMPI)

NAME
       MMPPIICCoommmmddeelleetteeaattttrr - Deletes attribute value associated with a key.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICommdeleteattr(MPIComm comm, int commkeyval)


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


CC++++ SSyynnttaaxx
       #include 
       void MPI::Comm::Deleteattr(int commkeyval)


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       comm      Communicator from which the attribute is deleted (handle).


IINNPPUUTT PPAARRAAMMEETTEERR
       commkeyval
                 Key value (integer).


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


DESCRIPTION
       MPICommdeleteattr deletes an attribute from cache by key. This func-
       tion invokes the attribute delete function deletefn specified when the
       commkeyval  was  created. The call will fail if the deletefn function
       returns an error code other than MPISUCCESS.

       Whenever a communicator is replicated using the function  MPICommdup,
       all  callback  copy functions for attributes that are currently set are
       invoked (in arbitrary order). Whenever a communicator is deleted  using
       the   function   MPICommfree,   all  callback  delete  functions  for
       attributes that are currently set are invoked.

       This function is the same as MPIAttrdelete but is needed to match the
       communicator-specific  functions  introduced in the MPI-2 standard. The
       use of MPIAttrdelete is deprecated.



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  MPICommdeleteattr(3OpenMPI)