Last modified: 15 April 2013
Name: H5Oget_info_by_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 )

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

Description:
H5Oget_info_by_name 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 H5Oget_info function entry.

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

Parameters:
hid_t loc_id IN: File or group identifier specifying location of group in which object is located
const char *name IN: Name of group, relative to loc_id
H5O_info_t *object_info     OUT: Buffer in which to return object information
hid_t lapl_id IN: Link access property list
(Not currently used; pass as H5P_DEFAULT.)

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

Fortran2003 Interface: h5oget_info_by_name_f

 

Related Fortran2003 Derived Type: h5o_info_t

History:
Release     Change
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.