Removes an attribute from a specified location
Procedure:
H5A_DELETE_BY_NAME ( loc_id, obj_name, attr_name, lapl_id )
Signature:
herr_t H5Adelete_by_name(
hid_t loc_id,
const char *obj_name,
const char *attr_name,
hid_t lapl_id
)
Fortran90 Interface: h5adelete_by_name_f
SUBROUTINE h5adelete_by_name_f(loc_id, obj_name, attr_name, hdferr, lapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! Identifer for object to which
! attribute is attached
CHARACTER(LEN=*), INTENT(IN) :: obj_name
! Name of object, relative to location,
! from which attribute is to be removed
CHARACTER(LEN=*), INTENT(IN) :: attr_name
! Name of attribute to delete
INTEGER, INTENT(OUT) :: hdferr ! Error code:
! 0 on success and -1 on failure
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id
! Link access property list
END SUBROUTINE h5adelete_by_name_f
Parameters:
hid_t loc_id | IN: Location or object identifier; may be a file, group, dataset, or named datatype |
const char *obj_name | IN: Name of object, relative to location, from which attribute is to be removed |
const char *attr_name | IN: Name of attribute to delete |
hid_t lapl_id | IN: Link access property list |
Description:
H5A_DELETE_BY_NAME removes the attribute attr_name from an object specified by location and name, loc_id and obj_name, respectively.
If loc_id fully specifies the object from which the attribute is to be removed, obj_name should be '.' (a dot).
The link access property list, lapl_id, may provide information regarding the properties of links required to access the object, obj_name. See “Link Access Properties” in the H5P APIs.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.8.0 | Function introduced in this release. |
--- Last Modified: December 20, 2018 | 01:57 PM
