Open MPI logo

MPI_Comm_delete_attr(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Comm_delete_attrR] - Deletes attribute value associated with a key.

Syntax

C Syntax



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



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_COMM_DELETE_ATTR(COMM, COMM_KEYVAL, IERROR) INTEGER COMM, COMM_KEYVAL, IERROR R]Fortran 2008 Syntax



C]USE mpi_f08MPI_Comm_delete_attr(comm, comm_keyval, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm INTEGER, INTENT(IN) :: comm_keyval INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input/Output Parameter

[bu]
C]commR] : Communicator from which the attribute is deleted (handle).

Input Parameter

[bu]
C]comm_keyvalR] : Key value (integer).

Output Parameter

[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_Comm_delete_attrR] deletes an attribute from cache by key. This function invokes the attribute delete function C]delete_fnR] specified when the C]comm_keyvalR] was created. The call will fail if the C]delete_fnR] function returns an error code other than C]MPI_SUCCESS.R] Whenever a communicator is replicated using the function C]MPI_Comm_dupR], all callback copy functions for attributes that are currently set are invoked (in arbitrary order). Whenever a communicator is deleted using the function C]MPI_Comm_freeR], all callback delete functions for attributes that are currently set are invoked. This function is the same as C]MPI_Attr_deleteR] but is needed to match the C]commR]unicator-specific functions introduced in the MPI-2 standard. The use of C]MPI_Attr_deleteR] is deprecated.

Notes

Note that it is not defined by the MPI standard what happens if the C]delete_fnR] callback invokes other MPI functions. In Open MPI, it is not valid for C]delete_fnR] callbacks (or any of their children) to add or delete attributes on the same object on which the C]delete_fnR] callback is being invoked.

Errors

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. 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 C]MPI_Comm_set_errhandlerR]; the predefined error handler C]MPI_ERRORS_RETURNR] 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.


Table of Contents

« Return to documentation listing