- Created by Barbara Jones, last modified on Mar 13, 2020
H5O_GET_INFO_BY_IDX3
Retrieves the metadata for an object, identifying the object by an index position
Procedure:
H5O_GET_INFO_BY_IDX3 ( loc_id, group_name, idx_type, order, n, oinfo, fields, lapl_id )
Signature:
herr_t H5Oget_info_by_idx3 ( hid_t loc_id, const char *group_name, H5_index_t idx_type,
H5_iter_order_t order, hsize_t n, H5O_info2_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
Related Fortran2003 Derived Type: h5o_info_t
TYPE, BIND(C) :: h5o_info_t
INTEGER(C_LONG) :: fileno ! File number that object is located in
TYPE(H5O_TOKEN_T_F) :: token ! Token for object in file
INTEGER(C_INT) :: type ! Basic object type (group, dataset, etc.)
INTEGER :: rc ! Reference count of object
INTEGER, DIMENSION(8) :: atime ! Access time ! -- NOTE --
INTEGER, DIMENSION(8) :: mtime ! Modification time ! Returns an integer array
INTEGER, DIMENSION(8) :: ctime ! Change time ! as specified in the Fortran
INTEGER, DIMENSION(8) :: btime ! Birth time ! intrinsic DATE_AND_TIME(VALUES)
INTEGER(hsize_t) :: num_attrs ! # of attributes attached to object
END TYPE h5o_info_t
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_info2_t *oinfo | OUT: Buffer in which to return object information |
unsigned int fields | IN: Flags specifying the fields to include in object_info |
hid_t lapl_id | IN: Link access property list (Not currently used; pass as NULL.) |
Description:
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 .
If 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 H5public.h as:
Include Bitbucket Server for Confluence: File content cannot be shown
Unauthenticated access to this resource is not allowed. Please login to Confluence first.order is of type H5_iter_order_t defined in H5public.h as:
Include Bitbucket Server for Confluence: File content cannot be shown
Unauthenticated access to this resource is not allowed. Please login to Confluence first.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:
Include Bitbucket Server for Confluence: File content cannot be shown
Unauthenticated access to this resource is not allowed. Please login to Confluence first.Note the following about H50_info2_t:
- Of the four time fields (
atime,mtime,ctime, andbtime) onlyctimehas been implemented. - The
atimevalue is the last time the object was read or written. - The
mtimevalue is the last time the raw data in the object was changed. - The
ctimevalue is the last time the metadata for the object was changed. - The
btimevalue is the time the object was created.
H5O_token_t is defined in H5public.h as follows:
Include Bitbucket Server for Confluence: File content cannot be shown
Unauthenticated access to this resource is not allowed. Please login to Confluence first.The H5O_type_t enum indicates the object type and is defined (in H5Opublic.h) as follows:
Include Bitbucket Server for Confluence: File content cannot be shown
Unauthenticated access to this resource is not allowed. Please login to Confluence first.Note that object_id refers only to the types specified by H5O_type_t.
The 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 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.
Example:
Include Bitbucket Server for Confluence: File content cannot be shown
Unauthenticated access to this resource is not allowed. Please login to Confluence first.
History:
| Release | Change |
|---|---|
| 1.12.0 | Function was introduced in this release. |
--- Last Modified: March 13, 2020 | 11:53 AM