Page tree

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

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Retrieves information about a group

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5G_GET_INFO_BY_NAME(loc_id, group_name, group_info, lapl_id)

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">herr_t H5Gget_info_by_name( hid_t loc_id, const char *group_name, H5G_info_t *group_info, hid_t lapl_id )</code></pre>
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">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</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
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

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

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

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

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

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Coming soon!

Comment
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

 

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
C
Release    Change
1.8.2Added 'mounted' field.
1.8.0Function introduced in this release.