.\" -*- nroff -*- .\" Copyright (c) 2010-2014 Cisco Systems, Inc. All rights reserved. .\" Copyright 2006-2008 Sun Microsystems, Inc. .\" Copyright (c) 1996 Thinking Machines .\" $COPYRIGHT$ .TH MPI_Type_delete_attr 3 "Sep 30, 2023" "4.1.6" "Open MPI" .SH NAME \fBMPI_Type_delete_attr\fP \- Deletes a datatype-caching attribute value associated with a key. .SH SYNTAX .ft R .SH C Syntax .nf #include int MPI_Type_delete_attr(MPI_Datatype \fItype\fP, int \fItype_keyval\fP) .fi .SH Fortran Syntax .nf USE MPI ! or the older form: INCLUDE 'mpif.h' MPI_TYPE_DELETE_ATTR(\fITYPE, TYPE_KEYVAL, IERROR\fP) INTEGER \fITYPE, TYPE_KEYVAL, IERROR \fP .fi .SH Fortran 2008 Syntax .nf USE mpi_f08 MPI_Type_delete_attr(\fIdatatype\fP, \fItype_keyval\fP, \fIierror\fP) TYPE(MPI_Datatype), INTENT(IN) :: \fIdatatype\fP INTEGER, INTENT(IN) :: \fItype_keyval\fP INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP .fi .SH C++ Syntax .nf #include void MPI::Datatype::Delete_attr(int \fItype_keyval\fP) .fi .SH INPUT/OUTPUT PARAMETER .ft R .TP 1i type Data type from which the attribute is deleted (handle).n .SH INPUT PARAMETER .ft R .TP 1i type_keyval Key value (integer). .SH OUTPUT PARAMETER .ft R .TP 1i IERROR Fortran only: Error status (integer). .SH DESCRIPTION .ft R MPI_Type_delete_attr deletes a datatype-caching attribute value associated with a key. This routines partially replaces MPI_Attr_delete, which is now deprecated. .SH NOTES Note that it is not defined by the MPI standard what happens if the delete_fn callback invokes other MPI functions. In Open MPI, it is not valid for delete_fn callbacks (or any of their children) to add or delete attributes on the same object on which the delete_fn callback is being invoked. .SH 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. .sp 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.