Name: H5Ldelete_by_idx
Signature:
  herr_t `H5Ldelete_by_idx`( hid_t `loc_id`, const char *`group_name`, H5_index_t `index_field`, H5_iter_order_t `order`, hsize_t `n`, hid_t `lapl_id` )

Purpose:
  Removes the nth link in a group.

Description:
  `H5Ldelete_by_idx` removes the nth link in a group according to the specified order, `order`, in the specified index, `index`.

  If `loc_id` specifies the group in which the link resides, `group_name` can be a dot (.).

Parameters:

  hid_t `loc_id` | IN: File or group identifier specifying location of subject group
  const char *`group_name` | IN: Name of subject group
  H5_index_t `index_field` | IN: Index or field which determines the order
  H5_iter_order_t `order` | IN: Order within field or index
  hsize_t `n` | IN: Link for which to retrieve information
  hid_t `lapl_id` | IN: Link access property list

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

Fortran90 Interface: h5ldelete_by_idx_f

      SUBROUTINE h5ldelete_by_idx_f(loc_id, group_name, index_field, 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) :: group_name
                                 ! Name of object, relative to location,
                                 ! from which attribute is to be removed
        INTEGER, INTENT(IN) :: index_field
                                 ! 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;
                                 ! Possible values are:
                                 !    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 h5ldelete_by_idx_f

History:

  Release | C
  1.8.0 | Function introduced in this release.