Retrieves the metadata for an object, identifying the object by location and relative name
Procedure:
H5O_GET_INFO_BY_NAME1 ( loc_id, name, oinfo, lapl_id )
Signature:
herr_t H5Oget_info_by_name1 ( hid_t loc_id, const char *name, H5O_info1_t *oinfo, 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_id | IN: Location identifier specifying group in which object is located; may be a file, group, dataset, named datatype or attribute identifier |
const char *name | IN: Name of group, relative to loc_id |
H5O_info1_t *oinfo | OUT: Buffer in which to return object information |
hid_t lapl_id | IN: 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 name, respectively, and retrieves the metadata describing that object in oinfo, an H5O_info1_t struct.
The struct H5O_info1_t is defined in H5Opublic.h and described in the H5O_GET_INFO1 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:
History:
| Release | Change |
|---|
| 1.10.5 | The macro H5O_GET_INFO_BY_NAME was removed and the function H5O_GET_INFO_BY_NAME1 was copied to H5O_GET_INFO_BY_NAME. |
| 1.10.3 | Function H5O_GET_INFO_BY_NAME was copied to H5O_GET_INFO_BY_NAME1 and the macro H5O_GET_INFO_BY_NAME was created. |
| 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. |
--- Last Modified: February 18, 2020 | 12:56 PM
