Name: H5Gget_info
Signature:
herr_t H5Gget_info( hid_t group_id, H5G_info_t *group_info )

Purpose:
Retrieves information about a group.

Description:
H5Gget_info retrieves information about the group specified by group_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 nlinks Number of links in group
     int64_t max_corder Current maximum creation order value for group
     hbool_t mounted Whether the group has a file mounted on it

Parameters:
hid_t group_id IN: Group identifier
H5G_info_t *group_info     OUT: Struct in which group information is returned

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

Fortran90 Interface: h5gget_info_f
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
    

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