H5Oopen_by_idx
(
hid_t loc_id
,
const char *group_name
,
H5_index_t index_type
,
H5_iter_order_t order
,
hsize_t n
,
hid_t lapl_id
)
H5Oopen_by_idx
opens the nth object in
the group specified by loc_id
and group_name
.
loc_id
specifies a file or group.
group_name
specifies the group relative to
loc_id
in which the object can be found.
If loc_id
fully specifies the group in which the object
resides, group_name
can be a dot (.).
The specific object to be opened within the group is specified
by index_type
, order
, and n
as follows:
index_type
specifies the type of index
by which objects are ordered.
Valid index types include
H5_INDEX_NAME
, indexed by name, and
H5_INDEX_CRT_ORDER
, indexed by creation order.
order
specifies the order in which the links
are to be referenced for the purposes of this function.
Valid orders include
H5_ITER_INC
for increasing order,
H5_ITER_DEC
for decreasing order, and
H5_ITER_NATIVE
.
Rather than implying a particular order,
H5_ITER_NATIVE
instructs the HDF5 Library
to iterate through the objects in the fastest available order,
i.e., in a natural order.
n
specifies the position of the object within
the index. Note that this count is zero-based;
0
(zero) indicates that the function will return
the value of the first object;
if n
is 5
, the function will return
the value of the sixth object; etc.
If lapl_id
specifies the link access property list
to be used in accessing the object.
hid_t loc_id |
IN: A file or group identifier. |
const char *group_name |
IN: Name of group, relative to loc_id ,
in which object is located |
H5_index_t index_type |
IN: Type of index by which objects are ordered |
H5_iter_order_t order |
IN: Order of iteration within index |
hsize_t n |
IN: Object to open |
hid_t lapl_id |
IN: Link access property list |
Release | C |
1.8.0 | Function introduced in this release. |