Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5G_GET_INFO_BY_NAME

Retrieves information about a group

Procedure:

H5G_GET_INFO_BY_NAME(loc_id, group_name, group_info, lapl_id)

Signature:

herr_t H5Gget_info_by_name( hid_t loc_id, const char *group_name, H5G_info_t *group_info, hid_t lapl_id )

SUBROUTINE h5gget_info_by_name_f(loc_id, group_name, &
     storage_type, nlinks, max_corder, hdferr, lapl_id, mounted)

  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: loc_id 
                             ! File or group identifier
  CHARACTER(LEN=*), INTENT(IN) :: group_name 
                             ! Name of group containing group for which 
                             ! information is to be retrieved
  INTEGER, INTENT(OUT) :: storage_type 
                             ! Type of storage for links in group:
                             !   H5G_STORAGE_TYPE_COMPACT_F: Compact storage
                             !   H5G_STORAGE_TYPE_DENSE_F: Indexed storage
                             !   H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables
  INTEGER, INTENT(OUT) :: nlinks 
                             ! Number of links in group
  INTEGER, INTENT(OUT) :: max_corder 
                             ! Current maximum creation order value for group
    
  INTEGER, INTENT(OUT) :: hdferr       
                             ! Error code:
                             ! 0 on success and -1 on failure
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id 
                             ! Link access property list
  LOGICAL, INTENT(OUT), OPTIONAL :: mounted      
                             ! Whether group has a file mounted on it
END SUBROUTINE h5gget_info_by_name_f

Parameters:
hid_t loc_idIN: File, group, dataset, named datatype, or attribute identifier
const char *group_nameIN: Name of group for which information is to be retrieved
H5G_info_t *group_info    OUT: Struct in which group information is returned
hid_t lapl_idIN: Link access property list

Description:

H5G_GET_INFO_BY_NAME retrieves information about the group group_name specified by loc_id. The information is returned in the group_info struct.

If loc_id specifies the group for which information is queried, group_name can be a dot (.).

group_info is an H5G_info_t struct and is defined (in H5Gpublic.h) as follows:

H5G_storage_type_t storage_type  Type of storage for links in group 
    H5G_STORAGE_TYPE_COMPACT: Compact storage 
    H5G_STORAGE_TYPE_DENSE: Dense storage 
    H5G_STORAGE_TYPE_SYMBOL_TABLE
         Symbol tables, the original HDF5 structure
hsize_t nlinksNumber of links in group
int64_t max_corderCurrent maximum creation order value for group
hbool_t mountedWhether the group has a file mounted on it

Returns:

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

Example:

Coming soon!

 

History:
Release    C
1.8.2Added 'mounted' field.
1.8.0Function introduced in this release.

--- Last Modified: April 25, 2018 | 03:12 PM