Name: H5Gget_info_by_idx
Signature:
  herr_t `H5Gget_info_by_idx`( hid_t `loc_id`, const char *`group_name`, H5_index_t `index_type`, H5_iter_order_t `order`, hsize_t `n`, H5G_info_t *`group_info`, hid_t `lapl_id` )

Purpose:
  Retrieves information about a group, according to the group’s position within an index.

Description:
  `H5Gget_info_by_idx` retrieves the same imformation about a group as retrieved by the function `H5Gget_info`, immediately above, but the means of identifying the group differs; the group is identified by position in an index rather than by name.

  `loc_id` and `group_name` specify the group containing the group for which information is sought. The groups in `group_name` are indexed by `index_type`; the group for which information is retrieved is identified in that index by index order, `order`, and index position, `n`.

  If `loc_id` specifies the group containing the group for which information is queried, `group_name` can be a dot (.).

  Valid values for `index_type` are as follows:

  | `H5_INDEX_NAME` |  | An alpha-numeric index by group name
  | `H5_INDEX_CRT_ORDER` |  | An index by creation order

  The order in which the index is to be examined, as specified by `order`, can be one of the following:

  | `H5_ITER_INC` |  | The count is from beginning of the index, i.e., top-down.
  | `H5_ITER_DEC` |  | The count is from the end of the index, i.e., bottom-up.
  | `H5_ITER_NATIVE` |  | HDF5 counts through the index in the fastest-available order. No information is provided as to the order, but HDF5 ensures that no element in the index will be overlooked.

Parameters:

  hid_t `loc_id` | IN: File or group identifier
  const char *`group_name` | IN: Name of group containing group for which information is to be retrieved
  H5_index_t `index_type` | IN: Index type
  H5_iter_order_t `order` | IN: Order of the count in the index
  hsize_t `n` | IN: Position in the index of the group for which information is retrieved
  H5G_info_t *`group_info` | OUT: Struct in which group information is returned
  hid_t `lapl_id` | IN: Link access property list

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

Fortran90 Interface: h5gget_info_by_idx_f

      SUBROUTINE h5gget_info_by_idx_f(loc_id, group_name, index_type, order, n, &
           storage_type, nlinks, max_corder, hdferr, lapl_id, mounted)

        IMPLICIT NONE
        INTEGER(HID_T), INTENT(IN) :: loc_id
                                     ! File or group identifier
        CHARACTER(LEN=*), INTENT(IN) :: group_name
                                     ! Name of group containing group for which
                                     ! information is to be retrieved
        INTEGER, INTENT(IN) :: index_type
                                     ! Index type
        INTEGER, INTENT(IN) :: order
                                     ! Order of the count in the index
        INTEGER(HSIZE_T), INTENT(IN) :: n
                                     ! Position in the index of the group for which
                                     ! information is retrieved
        INTEGER, INTENT(OUT) :: storage_type
                                     ! Type of storage for links in group:
                                     ! H5G_STORAGE_TYPE_COMPACT_F: Compact storage
                                     ! H5G_STORAGE_TYPE_DENSE_F: Indexed storage
                                     ! H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables
        INTEGER, INTENT(OUT) :: nlinks
                                     ! Number of links in group
        INTEGER, INTENT(OUT) :: max_corder
                                     ! Current maximum creation order value for group
        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
        LOGICAL, INTENT(OUT), OPTIONAL :: mounted
                                     ! Whether group has a file mounted on it
      END SUBROUTINE h5gget_info_by_idx_f

History:

  Release | C
  1.8.0 | Function introduced in this release.