Deletes an attribute from a specified location

Procedure:

H5A_DELETE (loc_id, attr_name)

Signature:

<pre><code class="language-c">herr_t H5Adelete(
        hid_t loc_id,
        const char *attr_name
    )
</code></pre>

<pre><code class="language-fortran">Fortran90 Interface: h5adelete_f
    
SUBROUTINE h5adelete_f(obj_id, name, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: obj_id    ! Object identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name    ! Attribute name
  INTEGER, INTENT(OUT) :: hdferr          ! Error code:
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5adelete_f
	</code></pre>

Parameters:
hid_t loc_idIN: Identifier of the file, dataset, group, or named datatype to have the attribute deleted from
const char *attr_name    IN: Name of the attribute to delete

Description:

H5A_DELETE removes the attribute specified by its name, attr_name, from a file, dataset, group, or named datatype. This function should not be used when attribute identifiers are open on loc_id as it may cause the internal indexes of the attributes to change and future writes to the open attributes to produce incorrect results.

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example:

Coming Soon!

History: