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


H5O_GET_INFO_BY_NAME2(loc_id, name, object_info, fields, lapl_id)


<pre><code class="language-c">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 )</code></pre>

<pre><code class="language-fortran">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

hid_t loc_idIN: Location identifier specifying group in which object is located; may be a file, group, dataset, named datatype or attribute identifier
const char *nameIN: Name of group, relative to loc_id
H5O_info_t *object_info    OUT: Buffer in which to return object information
unsigned int fieldsIN: Flags specifying the fields to include in object_info
hid_t lapl_idIN: Link access property list
(Not currently used; pass as H5P_DEFAULT.)


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:

H5O_INFO_BASICFill in the fileno, addr, type, and rc fields
H5O_INFO_TIMEFill in the atime, mtime, ctime, and btime fields
H5O_INFO_NUM_ATTRSFill in the num_attrs field
H5O_INFO_HDRFill in the hdr field
H5O_INFO_META_SIZEFill in the meta_size field


The link access property list, lapl_id, is not currently used; it should be passed in as H5P_DEFAULT.


Returns a non-negative value if successful; otherwise returns a negative value.


Coming Soon!

Release    Change
1.10.3C function 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.