Last modified: 15 April 2013

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

Purpose:
  Retrieves the metadata for an object, identifying the object by an index position.

Description:
  `H5Oget_info_by_idx` specifies a location, `loc_id`; a group name, `group_name`; an index by which obects in that group are tracked, `index_field`; the order by which the index is to be traversed, `order`; and an object’s position `n` within that index and retrieves the metadata describing that object in the struct `object_info`.

  `object_info`, in which the object information is returned, is a struct of type H5O_info_t. This struct type is described in the `H5Oget_info` function entry.

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

  The link access property list, `lapl_id`, is not currently used; it should be passed in as `NULL`.

Parameters:

  hid_t `loc_id` | IN: File or group identifier specifying location of group in which object is located
  const char *`group_name` | IN: Name of group in which object is located
  H5_index_t `index_field` | IN: Index or field that determines the order
  H5_iter_order_t `order` | IN: Order within field or index
  hsize_t `n` | IN: Object for which information is to be returned
  H5O_info_t *`object_info` | OUT: Buffer in which to return object information
  hid_t `lapl_id` | IN: Link access property list (Not currently used; pass as `NULL`.)

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

Fortran2003 Interface: h5oget_info_by_idx_f

  Related Fortran2003 Derived Type: h5o_info_t

History:

  Release | C
  1.8.11 | Fortran subroutine introduced in this release.
  1.8.0 | Function introduced in this release.