This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

MPI_Comm_delete_attr(3OpenMPI)                                                MPI_Comm_delete_attr(3OpenMPI)



NAME
       MPI_Comm_delete_attr - Deletes attribute value associated with a key.


SYNTAX
C Syntax
       #include <mpi.h>
       int MPI_Comm_delete_attr(MPI_Comm comm, int comm_keyval)


Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_Comm_delete_attr(COMM, COMM_KEYVAL, IERROR)
            INTEGER   COMM, COMM_KEYVAL, IERROR


C++ Syntax
       #include <mpi.h>
       void MPI::Comm::Delete_attr(int comm_keyval)


INPUT/OUTPUT PARAMETER
       comm      Communicator from which the attribute is deleted (handle).


INPUT PARAMETER
       comm_keyval
                 Key value (integer).


OUTPUT PARAMETER
       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPI_Comm_delete_attr  deletes  an  attribute  from  cache by key. This function invokes the attribute
       delete function delete_fn specified when the comm_keyval was created.  The  call  will  fail  if  the
       delete_fn function returns an error code other than MPI_SUCCESS.

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

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



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++ functions 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_delete_attr(3OpenMPI)