Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5O_GET_INFO_BY_NAME3

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

Procedure:

H5O_GET_INFO_BY_NAME3  ( loc_id, name, oinfo, fields, lapl_id )

Signature:

herr_t H5Oget_info_by_name3 ( hid_t loc_id, const char *name, H5O_info2_t *oinfo, unsigned fields, hid_t lapl_id )

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

Related Fortran2003 Derived Type:  h5o_info_t

 

  TYPE, BIND(C) :: h5o_info_t
     INTEGER(C_LONG)     :: fileno     ! File number that object is located in
     TYPE(H5O_TOKEN_T_F) :: token      ! Token for object in file
     INTEGER(C_INT)      :: type       ! Basic object type (group, dataset, etc.)
     INTEGER             :: rc         ! Reference count of object

     INTEGER, DIMENSION(8) :: atime ! Access time         !    -- NOTE --
     INTEGER, DIMENSION(8) :: mtime ! Modification time   ! Returns an integer array
     INTEGER, DIMENSION(8) :: ctime ! Change time         ! as specified in the Fortran
     INTEGER, DIMENSION(8) :: btime ! Birth time          ! intrinsic DATE_AND_TIME(VALUES)

     INTEGER(hsize_t) :: num_attrs  ! # of attributes attached to object
  END TYPE h5o_info_t

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_info2_t *oinfo    OUT: Buffer in which to return object information
unsigned int fieldsIN: Flags specifying the fields to include in oinfo
hid_t lapl_idIN: Link access property list
(Not currently used; pass as H5P_DEFAULT.)

Description:

H5O_GET_INFO_BY_NAME3  specifies an object’s location and name, loc_id and name, respectively, and retrieves the metadata describing that object in oinfo, an H5O_info2_t struct.

oinfo, in which the object information is returned, is a struct of type H5O_info2_t, which is defined in H5Opublic.h in the HDF5 source code:  

Include Bitbucket Server for Confluence: Application link to Bitbucket Server is missing

You need an application link to Bitbucket Server to use this functionality. Please contact your system administrator to create one.

Note the following about  H50_info2_t:

  • Of the four time fields (atime,  mtime,  ctime, and  btime) only  ctime  has been implemented.
  • The  atime  value is the last time the object was read or written.
  • The  mtime  value is the last time the raw data in the object was changed.
  • The  ctime  value is the last time the metadata for the object was changed.
  • The  btime  value is the time the object was created.

H5O_token_t is defined in H5public.h as follows:

Include Bitbucket Server for Confluence: Application link to Bitbucket Server is missing

You need an application link to Bitbucket Server to use this functionality. Please contact your system administrator to create one.

The  H5O_type_t  enum indicates the object type and is defined (in  H5Opublic.h) as follows:

Include Bitbucket Server for Confluence: Application link to Bitbucket Server is missing

You need an application link to Bitbucket Server to use this functionality. Please contact your system administrator to create one.

Note that object_id refers only to the types specified by H5O_type_t.

The fields parameter contains flags to determine which fields will be filled in in the H5O_info2_t struct returned in oinfo. These flags are defined in the H5Opublic.h file:

FlagPurpose
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
H5O_INFO_ALLH5O_INFO_BASIC | H5O_INFO_TIME | H5O_INFO_NUM_ATTRS | H5O_INFO_HDR | H5O_INFO_META_SIZE

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:

Include Bitbucket Server for Confluence: Application link to Bitbucket Server is missing

You need an application link to Bitbucket Server to use this functionality. Please contact your system administrator to create one.

Include Bitbucket Server for Confluence: Application link to Bitbucket Server is missing

You need an application link to Bitbucket Server to use this functionality. Please contact your system administrator to create one.

History:
Release    Change
1.12.0Function introduced in this release.

--- Last Modified: March 17, 2020 | 11:08 AM