Returns global information for a file
Procedure:
H5F_GET_INFO2(obj_id, file_info)
Signature:
herr_t H5Fget_info2( hid_t obj_id, H5F_info2_t *file_info )
Parameters:
hid_t obj_id | IN: 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 |
Description:
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:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
Release | Change |
---|
1.10.0 | C function H5Fget_info2 introduced in this release. |
--- Last Modified: December 20, 2018 | 01:50 PM