H5O_GET_INFO_BY_IDX3 retrieves the metadata describing an object in the struct
oinfo, as specified by the location,
loc_id, group name,
group_name, the index by which objects in that group are tracked,
idx_type, the order by which the index is to be traversed,
order, and an object’s position
n within that index .
loc_id fully specifies the group in which the object resides,
group_name can be a dot (.).
idx_type is of type H5_index_t, defined in
order is of type H5_iter_order_t defined in
oinfo, in which the object information is returned, is a struct of type H5O_info2_t, which is defined in
H5Opublic.h in the HDF5 source code:
Note the following about H50_info2_t:
- Of the four time fields (
ctime has been implemented.
atime value is the last time the object was read or written.
mtime value is the last time the raw data in the object was changed.
ctime value is the last time the metadata for the object was changed.
btime value is the time the object was created.
H5O_token_t is defined in
H5public.h as follows:
The H5O_type_t enum indicates the object type and is defined (in
H5Opublic.h) as follows:
object_id refers only to the types specified by H5O_type_t.
fields parameter contains flags to determine which fields will be filled in in the H5O_info2_t struct returned in
oinfo. These flags are defined in the
|H5O_INFO_BASIC||Fill in the fileno, addr, type, and rc fields|
|H5O_INFO_TIME||Fill in the atime, mtime, ctime, and btime fields|
|H5O_INFO_NUM_ATTRS||Fill in the num_attrs field|
|H5O_INFO_HDR||Fill in the hdr field|
|H5O_INFO_META_SIZE||Fill in the meta_size field|
|H5O_INFO_ALL||H5O_INFO_BASIC | H5O_INFO_TIME | H5O_INFO_NUM_ATTRS | H5O_INFO_HDR | H5O_INFO_META_SIZE|
The link access property list,
lapl_id, is not currently used; it should be passed in as