Page tree

The license could not be verified: License Certificate has expired!

 

JAVA

FORTRAN

C++

C

 

Link

H5G_GET_INFO

Retrieves information about a group

Procedure:

H5G_GET_INFO(group_id, group_info)

Signature:

herr_t H5Gget_info( hid_t group_id, H5G_info_t *group_info )

SUBROUTINE h5gget_info_f(group_id, storage_type, nlinks, max_corder, hdferr, &
                         mounted)

  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: group_id 
                            ! Group identifier
  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
  LOGICAL, INTENT(OUT), OPTIONAL :: mounted      
                            ! Whether group has a file mounted on it

END SUBROUTINE h5gget_info_f

Parameters:
hid_t loc_idIN: File, group, dataset, named datatype or attribute identifier
H5G_info_t *group_info    OUT: Struct in which group information is returned

Description:

H5G_GET_INFO retrieves information about the group at location specified by loc_id. The information is returned in the group_info struct.

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: Indexed 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:11 PM