Name: H5Adelete_by_idx
Signature:
  herr_t `H5Adelete_by_idx`( hid_t `loc_id`, const char *`obj_name`, H5_index_t `idx_type`, H5_iter_order_t `order`, hsize_t `n`, hid_t `lapl_id` )

Purpose:
  Deletes an attribute from an object according to index order.

Description:
  `H5Adelete_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, `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 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 `idx_type`, `order`, and `n` are set to `H5_INDEX_NAME`, `H5_ITER_INC`, and `5`, respectively, the fifth attribute by alpha-numeric order of attribute names will be removed.

  For a discussion of `idx_type` and `order`, the valid values of those parameters, and the use of `n`, see the description of H5Aiterate2

  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.

Parameters:

  hid_t `loc_id` | IN: Location or object identifier; may be dataset or group
  const char *`obj_name` | IN: Name of object, relative to location, from which attribute is to be removed
  H5_index_t `idx_type` | IN: Type of index
  H5_iter_order_t `order` | IN: Order in which to iterate over index
  hsize_t `n` | IN: Offset within index
  hid_t `lapl_id` | IN: Link access property list

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

Fortran90 Interface: h5adelete_by_idx_f

      SUBROUTINE h5adelete_by_idx_f(loc_id, obj_name, idx_type, order, n,  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
        INTEGER, INTENT(IN) :: idx_type
                                  ! Type of index; Possible values are:
                                  !  H5_INDEX_UNKNOWN_F     - Unknown index type
                                  !    H5_INDEX_NAME_F      - Index on names
                                  !    H5_INDEX_CRT_ORDER_F - Index on creation order
                                  !    H5_INDEX_N_F	      - Number of indices defined
        INTEGER, INTENT(IN) :: order
                                  ! Order in which to iterate over index:
                                  !    H5_ITER_UNKNOWN_F  - Unknown order
                                  !    H5_ITER_INC_F      - Increasing order
                                  !    H5_ITER_DEC_F      - Decreasing order
                                  !    H5_ITER_NATIVE_F   - No particular order,
                                  !                         whatever is fastest
                                  !    H5_ITER_N_F	    - Number of iteration orders
        INTEGER(HSIZE_T), INTENT(IN) :: n
                                  ! Offset within index
        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_idx_f

History:

  Release | C
  1.8.0 | Function introduced in this release.