Retrieves the metadata for an object, identifying the object by an index position
Procedure:
H5O_GET_INFO_BY_IDX2 ( loc_id, group_name, idx_type, order, n, oinfo, fields, lapl_id )
Signature:
herr_t H5Oget_info_by_idx2 ( hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5O_info1_t *oinfo,
unsigned fields, hid_t lapl_id)
SUBROUTINE h5oget_info_by_idx_f(loc_id, group_name, index_field, order, n, &
object_info, hdferr, lapl_id, fields)
USE, INTRINSIC :: ISO_C_BINDING
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: group_name
INTEGER , INTENT(IN) :: index_field
INTEGER , INTENT(IN) :: order
INTEGER(HSIZE_T), INTENT(IN) :: n
TYPE(h5o_info_t), INTENT(OUT), TARGET :: object_info
INTEGER , INTENT(OUT) :: hdferr
INTEGER(HID_T) , INTENT(IN) , OPTIONAL :: lapl_id
INTEGER , INTENT(IN) , OPTIONAL :: fields
Parameters:
hid_t loc_id | IN: Location identifier of object; may be a file, group, dataset, named datatype or attribute identifier |
const char *group_name | IN: Name of group in which object is located |
H5_index_t idx_type | 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_info1_t *oinfo | OUT: Buffer in which to return object information |
unsigned int fields | IN: Flags specifying the fields to include in oinfo |
hid_t lapl_id | IN: Link access property list (Not currently used; pass as NULL .) |
Description:
H5O_GET_INFO_BY_IDX2 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 .
oinfo
, in which the object information is returned, is a struct of type H5O_info1_t. This and other struct types used by H5O_GET_INFO_BY_IDX2 are described in H5O_GET_INFO_BY_IDX1.
If loc_id
fully specifies the group in which the object resides, group_name
can be a dot (.).
The fields
parameter contains flags to determine which fields will be filled in in the H5O_info1_t struct returned in oinfo
. These flags are defined in the H5Opublic.h
file:
Flag | Purpose |
---|
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 NULL
.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
History:
Release | Change |
---|
1.10.3 | C function introduced in this release. |
--- Last Modified: February 19, 2020 | 03:11 PM