Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5O_GET_INFO_BY_NAME

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

Signature:

herr_t H5Oget_info_by_name( hid_t loc_id, const char *object_name, H5O_info_t *object_info, hid_t lapl_id )

 

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)

    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

Description:

H5O_GET_INFO_BY_NAME is a macro that is either mapped to H5O_GET_INFO_BY_NAME1 or H5O_GET_INFO_BY_NAME2

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.

If the library and/or application is compiled for Release 1.8 or 1.10 emulation, H5O_GET_INFO_BY_NAME will be mapped to H5O_GET_INFO_BY_NAME1. With later versions, H5O_GET_INFO_BY_NAME is mapped to H5O_GET_INFO_BY_NAME2 (and H5O_GET_INFO_BY_NAME1 is deprecated).

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

Compatibility settingsH5Oget_info_by_name
No compatibility flag

H5Oget_info_by_name1 for  1.8 or 1.10

H5Oget_info_by_name2 for > 1.10

Emulate Release 1.8 interface H5Oget_info_by_name1
Emulate Release 1.10 interfaceH5Oget_info_by_name1
Emulate Releases after 1.10H5Oget_info_by_name2


Example:

History:
Release    Change
1.10.3The function H5Oget_info_by_name was renamed to H5Oget_info_by_name1.The macro H5Oget_info_name and the function H5Oget_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: August 21, 2018 | 03:54 PM