MPI_Attr_delete(3)

NAME
MPI_Attr_delete - Remove any attributes attached to a keyval for a communicator

SYNOPSIS
#include <mpi.h>
int MPI_Attr_delete(MPI_Comm comm, int keyval);

#include <pmpi.h>
int PMPI_Attr_delete(MPI_Comm comm, int keyval);

INCLUDE 'mpif.h'
MPI_ATTR_DELETE(comm, keyval, ierr)
INTEGER comm, keyval, ierr

INPUT PARAMETERS
comm
    - communicator (handle)
keyval
    - key value (handle)

DESCRIPTION
The MPI_Attr_delete() function is used to remove an attribute attached to a keyval for a given communicator, comm. If there is not an attribute attached, then the MPI_ERR_KEYVAL error will be returned. Use the MPI_Attr_get() function to determine if any attribute exists before calling this function. If an attribute did exist, its delete function is called, and if successful, then the attribute will no longer be associated with the keyval for the communicator. PMPI_Attr_delete() is the profiling version of this function.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable. In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.
MPI_SUCCESS
    - No error;
MPI_ERR_PENDING
    - Pending exception;
MPI_ERR_COMM
    - Invalid communicator;
MPI_ERR_KEYVAL
    - Invalid keyval.

SEE ALSO
MPI_Keyval_create(3), MPI_Keyval_free(3), MPI_Attr_get(3), MPI_Attr_put(3)