Retrieves the metadata for an object, identifying the object by location and relative name
Procedure:
H5O_GET_INFO_BY_NAME2(loc_id, name, object_info, fields, lapl_id)
Signature:
herr_t H5Oget_info_by_name( hid_t loc_id, const char *object_name, H5O_info_t *object_info, unsigned int fields, hid_t lapl_id )
SUBROUTINE h5oget_info_by_name_f(loc_id, name, object_info, hdferr, &
lapl_id, fields)
INTEGER(HID_T) , INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
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 specifying group in which object is located; may be a file, group, dataset, named datatype or attribute identifier |
const char *name | IN: Name of group, relative to loc_id |
H5O_info_t *object_info | 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 H5P_DEFAULT.) |
Description:
H5O_GET_INFO_BY_NAME2 specifies an object’s location and name, loc_id and object_name, respectively, and retrieves the metadata describing that object in object_info, an H5O_info_t struct.
The struct H5O_info_t is defined in H5Opublic.h and described in the H5O_GET_INFO function entry.
The fields parameter contains flags to determine which fields will be filled in in the H5O_info_t struct returned in object_info. 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 H5P_DEFAULT.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
| 1.10.3 | C function introduced in this release. |
| 1.8.0 | C function introduced in this release. |
| 1.8.8 | Fortran 2003 subroutine and h5o_info_t derived type introduced in this release. |
--- Last Modified: February 20, 2019 | 01:19 PM
