H5A_DELETE_BY_IDX removes an attribute, specified by its location in an index, from an object.
The object from which the attribute is to be removed is specified by a location identifier and name,
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 attribute to be removed is specified by a position in an index,
n. The type of index is specified by
idx_type and may be
H5_INDEX_NAME, for an alpha-numeric index by name, or
H5_INDEX_CRT_ORDER, for an index by creation order. The order in which the index is to be traversed is specified by
order and may be
H5_ITER_INC (increment) for top-down iteration,
H5_ITER_DEC (decrement) for bottom-up iteration, or
H5_ITER_NATIVE, in which case HDF5 will iterate in the fastest-available order. For example, if
n are set to
5, respectively, the fifth attribute by alpha-numeric order of attribute names will be removed.
For a discussion of
order, the valid values of those parameters, and the use of
n, see the description of H5A_ITERATE2
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.