Retrieves the metadata for an object specified by an identifier
Procedure:
H5O_GET_INFO3 (loc_id, oinfo, fields)
Signature:
herr_t H5Oget_info3 ( hid_t loc_id, H5O_info2_t *oinfo, unsigned fields )
SUBROUTINE h5oget_info_f(object_id, object_info, hdferr, fields)
USE, INTRINSIC :: ISO_C_BINDING
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: object_id
TYPE(h5o_info_t), INTENT(OUT), TARGET :: object_info
INTEGER , INTENT(OUT) :: hdferr
INTEGER , INTENT(IN), OPTIONAL :: fields
Parameters:
hid_t loc_id | IN: Identifier for object of type specified by H5O_type_t; may be a file, group, dataset, named datatype or attribute identifier |
H5O_info2_t * oinfo | OUT: Buffer in which to return object information |
unsigned int
fields
| IN: Flags specifying the fields to include in oinfo |
Description:
H5O_GET_INFO3 specifies an object by its identifier, loc_id
, and retrieves the metadata describing that object in oinfo
, an H5O_info2_t struct.
The H5O_info2_t struct 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 the following about
H50_info2_t:
- Of the four time fields (
atime
, mtime
, ctime
, and btime
) only ctime
has been implemented. - The
atime
value is the last time the object was read or written. - The
mtime
value is the last time the raw data in the object was changed. - The
ctime
value is the last time the metadata for the object was changed. - The
btime
value 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 |
Note:
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.
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:06 AM