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

Returns global information for a file

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

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

H5F_GET_INFO2(obj_id, file_info)

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 H5Fget_info2( hid_t obj_id, H5F_info2_t *file_info )</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
hid_t obj_idIN: Object identifier for any object in the file; may be a file, group, dataset, named datatype, or attribute
H5F_info2_t *file_info  OUT: Struct containing global file information

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5F_GET_INFO2 returns global information for the file associated with the object identifier obj_id in the H5F_info2_t struct named file_info.

obj_id is an identifier for any object in the file of interest.

An H5F_info2_t struct is defined in H5Fpublic.h as follows:

        typedef struct H5F_info2_t {
	    struct {
		unsigned      vers;	
		hsize_t	      super_size;
		hsize_t	      super_ext_size;	
	    } super;
	    struct {
		unsigned      vers;
		hsize_t	      hdr_size;
		hsize_t	      tot_space;
	    } free;
            struct {
		unsigned      vers;
                hsize_t       hdr_size;		
                H5_ih_info_t  msgs_info; 
            } sohm;
        } H5F_info2_t; 

The super sub-struct contains the following information:

  • vers is the version number of the superblock.
  • super_size is the size of the superblock.
  • super_ext_size is the size of the superblock extension.

The free sub-struct contains the following information:

  • vers is the version number of the free-space manager.
  • hdr_size is the size of the free-space manager header.
  • tot_space is the total amount of free space in the file.

The sohm sub-struct contains shared object header message information as follows:

  • vers is the version number of the shared object header information.
  • hdr_size is the size of the shared object header message.
  • msgs_info is an H5_ih_info_t struct defined in H5public.h as follows:
            typedef struct H5_ih_info_t {
                hsize_t     index_size;     
                hsize_t     heap_size;
            } H5_ih_info_t;
    
    • index_size is the summed size of all the shared object header indexes. Each index might be either a B-tree or a list.
    • heap_size is the size of the heap.

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.10.0C function H5Fget_info2 introduced in this release.