Page tree









Retrieves the metadata for an object, identifying the object by location and relative name


[1] 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 )
[2] herr_t H5Oget_info_by_name( hid_t loc_id, const char *object_name, H5O_info_t *object_info, hid_t lapl_id )

SUBROUTINE h5oget_info_by_name_f(loc_id, name, object_info, hdferr,  &

    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


H5O_GET_INFO_BY_NAME is a macro that is mapped to either of:

Such macros are provided to facilitate application compatibility. Their use and mappings are fully described in API Compatibility Macros in HDF5; we urge you to read that document closely.

In HDF5 version 1.12 and later H5O_GET_INFO_BY_NAME is mapped to H5O_GET_INFO_BY_NAME3. In version 1.10 H5O_GET_INFO_BY_NAME is identical to H5O_GET_INFO_BY_NAME1.

If using 1.10 (1.10.3+) and encountering performance issues, please use  H5O_GET_INFO_BY_NAME2 to limit the fields retrieved, which can help with performance.

Specific compile-time compatibility flags and the resulting mappings are as follows:

Compatibility settingsH5Oget_info_by_name
No compatibility flag

H5O_GET_INFO_BY_NAME3 for 1.12 and above

H5O_GET_INFO_BY_NAME1 for 1.8 or 1.10

Emulate 1.12 interfaceH5O_GET_INFO_BY_NAME3
Emulate Release 1.10 or 1.8 interface H5O_GET_INFO_BY_NAME1

Release    Change
1.12.0The macro H5O_GET_INFO_BY_NAME and function H5O_GET_INFO_BY_NAME3 were added and H5O_GET_INFO_BY_NAME1 was deprecated.
1.10.5The macro H5O_GET_INFO_BY_NAME was removed. The functions H5O_GET_INFO_BY_NAME and H5O_GET_INFO_BY_NAME1 are identical in this release. This change was added to restore the broken API compatibility introduced in HDF5-1.10.3.
1.10.3The function H5O_GET_INFO_BY_NAME was renamed to H5O_GET_INFO_BY_NAME1. The macro H5O_GET_INFO_BY_NAME and the function H5O_GET_INFO_BY_NAME2 were introduced in this release.
1.8.0C function introduced in this release.
1.8.8Fortran 2003 subroutine and h5o_info_t derived type introduced in this release.

--- Last Modified: March 31, 2021 | 12:04 PM