Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5O_GET_INFO_BY_NAME1

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

 

This function has been renamed from H5Oget_info_by_name and is deprecated in favor of the macro H5O_GET_INFO_BY_NAME or the function H5O_GET_INFO_BY_NAME2.

For HDF5-1.10 and earlier releases, H5O_GET_INFO_BY_NAME is mapped to H5O_GET_INFO_BY_NAME1 by default.

Procedure:

H5O_GET_INFO_BY_NAME1(loc_id, name, object_info, lapl_id)

Signature:

herr_t H5Oget_info_by_name1( 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,  &
        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

Parameters:
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
hid_t lapl_idIN: Link access property list
(Not currently used; pass as H5P_DEFAULT.)

Description:

H5O_GET_INFO_BY_NAME1   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 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:

Coming Soon!

History:
Release    Change
1.10.3Function renamed H5Oget_info_by_name1.
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 | 04:05 PM