H5Fpublic.h File Reference

#include "H5public.h"
#include "H5ACpublic.h"
#include "H5Ipublic.h"

Go to the source code of this file.

Data Structures
struct	H5F_info2_t
struct	H5F_sect_info_t
struct	H5F_retry_info_t
struct	H5F_info1_t

Macros
#define	H5CHECK   H5check(),
#define	H5OPEN   H5open(),
#define	H5F_ACC_RDONLY   (H5CHECK H5OPEN 0x0000u) /*absence of rdwr => rd-only */
#define	H5F_ACC_RDWR   (H5CHECK H5OPEN 0x0001u) /*open for read and write */
#define	H5F_ACC_TRUNC   (H5CHECK H5OPEN 0x0002u) /*overwrite existing files */
#define	H5F_ACC_EXCL   (H5CHECK H5OPEN 0x0004u) /*fail if file already exists*/
#define	H5F_ACC_CREAT   (H5CHECK H5OPEN 0x0010u) /*create non-existing files */
#define	H5F_ACC_SWMR_WRITE
#define	H5F_ACC_SWMR_READ
#define	H5F_ACC_DEFAULT   (H5CHECK H5OPEN 0xffffu) /*ignore setting on lapl */
#define	H5F_OBJ_FILE   (0x0001u) /* File objects */
#define	H5F_OBJ_DATASET   (0x0002u) /* Dataset objects */
#define	H5F_OBJ_GROUP   (0x0004u) /* Group objects */
#define	H5F_OBJ_DATATYPE   (0x0008u) /* Named datatype objects */
#define	H5F_OBJ_ATTR   (0x0010u) /* Attribute objects */
#define	H5F_OBJ_ALL   (H5F_OBJ_FILE|H5F_OBJ_DATASET|H5F_OBJ_GROUP|H5F_OBJ_DATATYPE|H5F_OBJ_ATTR)
#define	H5F_OBJ_LOCAL   (0x0020u) /* Restrict search to objects opened through current file ID */
#define	H5F_FAMILY_DEFAULT   (hsize_t)0
#define	H5F_UNLIMITED   ((hsize_t)(-1L))
#define	H5F_LIBVER_LATEST   H5F_LIBVER_V112
#define	H5F_NUM_METADATA_READ_RETRY_TYPES   21
#define	H5F_ACC_DEBUG   (H5CHECK H5OPEN 0x0000u) /*print debug info (deprecated)*/

Typedefs
typedef enum H5F_scope_t	H5F_scope_t
typedef enum H5F_close_degree_t	H5F_close_degree_t
typedef struct H5F_info2_t	H5F_info2_t
typedef enum H5F_mem_t	H5F_mem_t
typedef struct H5F_sect_info_t	H5F_sect_info_t
typedef enum H5F_libver_t	H5F_libver_t
typedef enum H5F_fspace_strategy_t	H5F_fspace_strategy_t
typedef enum H5F_file_space_type_t	H5F_file_space_type_t
typedef struct H5F_retry_info_t	H5F_retry_info_t
typedef herr_t(*	H5F_flush_cb_t) (hid_t object_id, void *udata)
typedef struct H5F_info1_t	H5F_info1_t

Enumerations
enum	H5F_scope_t { H5F_SCOPE_LOCAL = 0, H5F_SCOPE_GLOBAL = 1 }
enum	H5F_close_degree_t { H5F_CLOSE_DEFAULT = 0, H5F_CLOSE_WEAK = 1, H5F_CLOSE_SEMI = 2, H5F_CLOSE_STRONG = 3 }
enum	H5F_mem_t {   H5FD_MEM_NOLIST = -1, H5FD_MEM_DEFAULT = 0, H5FD_MEM_SUPER = 1, H5FD_MEM_BTREE = 2,   H5FD_MEM_DRAW = 3, H5FD_MEM_GHEAP = 4, H5FD_MEM_LHEAP = 5, H5FD_MEM_OHDR = 6,   H5FD_MEM_NTYPES }
enum	H5F_libver_t {   H5F_LIBVER_ERROR = -1, H5F_LIBVER_EARLIEST = 0, H5F_LIBVER_V18 = 1, H5F_LIBVER_V110 = 2,   H5F_LIBVER_V112 = 3, H5F_LIBVER_NBOUNDS }
enum	H5F_fspace_strategy_t {   H5F_FSPACE_STRATEGY_FSM_AGGR = 0, H5F_FSPACE_STRATEGY_PAGE = 1, H5F_FSPACE_STRATEGY_AGGR = 2, H5F_FSPACE_STRATEGY_NONE = 3,   H5F_FSPACE_STRATEGY_NTYPES }
enum	H5F_file_space_type_t {   H5F_FILE_SPACE_DEFAULT = 0, H5F_FILE_SPACE_ALL_PERSIST = 1, H5F_FILE_SPACE_ALL = 2, H5F_FILE_SPACE_AGGR_VFD = 3,   H5F_FILE_SPACE_VFD = 4, H5F_FILE_SPACE_NTYPES }

Functions
H5_DLL htri_t	H5Fis_accessible (const char *container_name, hid_t fapl_id)
H5_DLL hid_t	H5Fcreate (const char *filename, unsigned flags, hid_t create_plist, hid_t access_plist)
H5_DLL hid_t	H5Fopen (const char *filename, unsigned flags, hid_t access_plist)
H5_DLL hid_t	H5Freopen (hid_t file_id)
H5_DLL herr_t	H5Fflush (hid_t object_id, H5F_scope_t scope)
H5_DLL herr_t	H5Fclose (hid_t file_id)
H5_DLL herr_t	H5Fdelete (const char *filename, hid_t fapl_id)
H5_DLL hid_t	H5Fget_create_plist (hid_t file_id)
H5_DLL hid_t	H5Fget_access_plist (hid_t file_id)
H5_DLL herr_t	H5Fget_intent (hid_t file_id, unsigned *intent)
H5_DLL herr_t	H5Fget_fileno (hid_t file_id, unsigned long *fileno)
H5_DLL ssize_t	H5Fget_obj_count (hid_t file_id, unsigned types)
H5_DLL ssize_t	H5Fget_obj_ids (hid_t file_id, unsigned types, size_t max_objs, hid_t *obj_id_list)
H5_DLL herr_t	H5Fget_vfd_handle (hid_t file_id, hid_t fapl, void **file_handle)
H5_DLL herr_t	H5Fmount (hid_t loc, const char *name, hid_t child, hid_t plist)
H5_DLL herr_t	H5Funmount (hid_t loc, const char *name)
H5_DLL hssize_t	H5Fget_freespace (hid_t file_id)
H5_DLL herr_t	H5Fget_filesize (hid_t file_id, hsize_t *size)
H5_DLL herr_t	H5Fget_eoa (hid_t file_id, haddr_t *eoa)
H5_DLL herr_t	H5Fincrement_filesize (hid_t file_id, hsize_t increment)
H5_DLL ssize_t	H5Fget_file_image (hid_t file_id, void *buf_ptr, size_t buf_len)
H5_DLL herr_t	H5Fget_mdc_config (hid_t file_id, H5AC_cache_config_t *config_ptr)
H5_DLL herr_t	H5Fset_mdc_config (hid_t file_id, H5AC_cache_config_t *config_ptr)
H5_DLL herr_t	H5Fget_mdc_hit_rate (hid_t file_id, double *hit_rate_ptr)
H5_DLL herr_t	H5Fget_mdc_size (hid_t file_id, size_t *max_size_ptr, size_t *min_clean_size_ptr, size_t *cur_size_ptr, int *cur_num_entries_ptr)
H5_DLL herr_t	H5Freset_mdc_hit_rate_stats (hid_t file_id)
H5_DLL ssize_t	H5Fget_name (hid_t obj_id, char *name, size_t size)
H5_DLL herr_t	H5Fget_info2 (hid_t obj_id, H5F_info2_t *finfo)
H5_DLL herr_t	H5Fget_metadata_read_retry_info (hid_t file_id, H5F_retry_info_t *info)
H5_DLL herr_t	H5Fstart_swmr_write (hid_t file_id)
H5_DLL ssize_t	H5Fget_free_sections (hid_t file_id, H5F_mem_t type, size_t nsects, H5F_sect_info_t *sect_info)
H5_DLL herr_t	H5Fclear_elink_file_cache (hid_t file_id)
H5_DLL herr_t	H5Fset_libver_bounds (hid_t file_id, H5F_libver_t low, H5F_libver_t high)
H5_DLL herr_t	H5Fstart_mdc_logging (hid_t file_id)
H5_DLL herr_t	H5Fstop_mdc_logging (hid_t file_id)
H5_DLL herr_t	H5Fget_mdc_logging_status (hid_t file_id, hbool_t *is_enabled, hbool_t *is_currently_logging)
H5_DLL herr_t	H5Fformat_convert (hid_t fid)
H5_DLL herr_t	H5Freset_page_buffering_stats (hid_t file_id)
H5_DLL herr_t	H5Fget_page_buffering_stats (hid_t file_id, unsigned accesses[2], unsigned hits[2], unsigned misses[2], unsigned evictions[2], unsigned bypasses[2])
H5_DLL herr_t	H5Fget_mdc_image_info (hid_t file_id, haddr_t *image_addr, hsize_t *image_size)
H5_DLL herr_t	H5Fget_dset_no_attrs_hint (hid_t file_id, hbool_t *minimize)
H5_DLL herr_t	H5Fset_dset_no_attrs_hint (hid_t file_id, hbool_t minimize)
H5_DLL herr_t	H5Fget_info1 (hid_t obj_id, H5F_info1_t *finfo)
H5_DLL herr_t	H5Fset_latest_format (hid_t file_id, hbool_t latest_format)
H5_DLL htri_t	H5Fis_hdf5 (const char *filename)

Macro Definition Documentation

H5CHECK

#define H5CHECK   H5check(),

H5F_ACC_CREAT

#define H5F_ACC_CREAT   (H5CHECK H5OPEN 0x0010u) /*create non-existing files */

H5F_ACC_DEBUG

#define H5F_ACC_DEBUG   (H5CHECK H5OPEN 0x0000u) /*print debug info (deprecated)*/

H5F_ACC_DEFAULT

#define H5F_ACC_DEFAULT   (H5CHECK H5OPEN 0xffffu) /*ignore setting on lapl */

H5F_ACC_EXCL

#define H5F_ACC_EXCL   (H5CHECK H5OPEN 0x0004u) /*fail if file already exists*/

H5F_ACC_RDONLY

#define H5F_ACC_RDONLY   (H5CHECK H5OPEN 0x0000u) /*absence of rdwr => rd-only */

H5F_ACC_RDWR

#define H5F_ACC_RDWR   (H5CHECK H5OPEN 0x0001u) /*open for read and write */

H5F_ACC_SWMR_READ

#define H5F_ACC_SWMR_READ

Value:

                                                 (H5CHECK 0x0040u) /*indicate that this file is
                                                 * open for reading in a
                                                 * single-writer/multi-reader (SWMR)
                                                 * scenario.  Note that the
                                                 * process(es) opening the file
                                                 * for SWMR reading must also
                                                 * open the file with the RDONLY
                                                 * flag.  */

H5F_ACC_SWMR_WRITE

#define H5F_ACC_SWMR_WRITE

Value:

                                                 (H5CHECK 0x0020u) /*indicate that this file is
                                                 * open for writing in a
                                                 * single-writer/multi-reader (SWMR)
                                                 * scenario.  Note that the
                                                 * process(es) opening the file
                                                 * for reading must open the file
                                                 * with RDONLY access, and use
                                                 * the special "SWMR_READ" access
                                                 * flag. */

H5F_ACC_TRUNC

#define H5F_ACC_TRUNC   (H5CHECK H5OPEN 0x0002u) /*overwrite existing files */

H5F_FAMILY_DEFAULT

#define H5F_FAMILY_DEFAULT   (hsize_t)0

H5F_LIBVER_LATEST

#define H5F_LIBVER_LATEST   H5F_LIBVER_V112

H5F_NUM_METADATA_READ_RETRY_TYPES

#define H5F_NUM_METADATA_READ_RETRY_TYPES   21

H5F_OBJ_ALL

#define H5F_OBJ_ALL   (H5F_OBJ_FILE|H5F_OBJ_DATASET|H5F_OBJ_GROUP|H5F_OBJ_DATATYPE|H5F_OBJ_ATTR)

H5F_OBJ_ATTR

#define H5F_OBJ_ATTR   (0x0010u) /* Attribute objects */

H5F_OBJ_DATASET

#define H5F_OBJ_DATASET   (0x0002u) /* Dataset objects */

H5F_OBJ_DATATYPE

#define H5F_OBJ_DATATYPE   (0x0008u) /* Named datatype objects */

H5F_OBJ_FILE

#define H5F_OBJ_FILE   (0x0001u) /* File objects */

H5F_OBJ_GROUP

#define H5F_OBJ_GROUP   (0x0004u) /* Group objects */

H5F_OBJ_LOCAL

#define H5F_OBJ_LOCAL   (0x0020u) /* Restrict search to objects opened through current file ID */

H5F_UNLIMITED

#define H5F_UNLIMITED   ((hsize_t)(-1L))

H5OPEN

#define H5OPEN   H5open(),

Typedef Documentation

H5F_close_degree_t

typedef enum H5F_close_degree_t H5F_close_degree_t

H5F_file_space_type_t

typedef enum H5F_file_space_type_t H5F_file_space_type_t

H5F_flush_cb_t

typedef herr_t(* H5F_flush_cb_t) (hid_t object_id, void *udata)

H5F_fspace_strategy_t

typedef enum H5F_fspace_strategy_t H5F_fspace_strategy_t

H5F_info1_t

typedef struct H5F_info1_t H5F_info1_t

H5F_info2_t

typedef struct H5F_info2_t H5F_info2_t

H5F_libver_t

typedef enum H5F_libver_t H5F_libver_t

H5F_mem_t

typedef enum H5F_mem_t H5F_mem_t

H5F_retry_info_t

typedef struct H5F_retry_info_t H5F_retry_info_t

H5F_scope_t

typedef enum H5F_scope_t H5F_scope_t

H5F_sect_info_t

typedef struct H5F_sect_info_t H5F_sect_info_t

Enumeration Type Documentation

H5F_close_degree_t

enum H5F_close_degree_t

Enumerator
H5F_CLOSE_DEFAULT
H5F_CLOSE_WEAK
H5F_CLOSE_SEMI
H5F_CLOSE_STRONG

H5F_file_space_type_t

enum H5F_file_space_type_t

Enumerator
H5F_FILE_SPACE_DEFAULT
H5F_FILE_SPACE_ALL_PERSIST
H5F_FILE_SPACE_ALL
H5F_FILE_SPACE_AGGR_VFD
H5F_FILE_SPACE_VFD
H5F_FILE_SPACE_NTYPES

H5F_fspace_strategy_t

enum H5F_fspace_strategy_t

Enumerator
H5F_FSPACE_STRATEGY_FSM_AGGR
H5F_FSPACE_STRATEGY_PAGE
H5F_FSPACE_STRATEGY_AGGR
H5F_FSPACE_STRATEGY_NONE
H5F_FSPACE_STRATEGY_NTYPES

H5F_libver_t

enum H5F_libver_t

Enumerator
H5F_LIBVER_ERROR
H5F_LIBVER_EARLIEST
H5F_LIBVER_V18
H5F_LIBVER_V110
H5F_LIBVER_V112
H5F_LIBVER_NBOUNDS

H5F_mem_t

enum H5F_mem_t

Enumerator
H5FD_MEM_NOLIST
H5FD_MEM_DEFAULT
H5FD_MEM_SUPER
H5FD_MEM_BTREE
H5FD_MEM_DRAW
H5FD_MEM_GHEAP
H5FD_MEM_LHEAP
H5FD_MEM_OHDR
H5FD_MEM_NTYPES

H5F_scope_t

enum H5F_scope_t

Enumerator
H5F_SCOPE_LOCAL
H5F_SCOPE_GLOBAL

Function Documentation

H5Fclear_elink_file_cache()

H5_DLL herr_t H5Fclear_elink_file_cache

(

hid_t

file_id

)

H5Fclose()

H5_DLL herr_t H5Fclose

(

hid_t

file_id

)

H5Fcreate()

H5_DLL hid_t H5Fcreate	(	const char *	filename,
		unsigned	flags,
		hid_t	create_plist,
		hid_t	access_plist
	)

H5Fdelete()

H5_DLL herr_t H5Fdelete	(	const char *	filename,
		hid_t	fapl_id
	)

H5Fflush()

H5_DLL herr_t H5Fflush	(	hid_t	object_id,
		H5F_scope_t	scope
	)

H5Fformat_convert()

H5_DLL herr_t H5Fformat_convert

(

hid_t

fid

)

H5Fget_access_plist()

H5_DLL hid_t H5Fget_access_plist

(

hid_t

file_id

)

H5Fget_create_plist()

H5_DLL hid_t H5Fget_create_plist

(

hid_t

file_id

)

H5Fget_dset_no_attrs_hint()

H5_DLL herr_t H5Fget_dset_no_attrs_hint	(	hid_t	file_id,
		hbool_t *	minimize
	)

H5Fget_eoa()

H5_DLL herr_t H5Fget_eoa	(	hid_t	file_id,
		haddr_t *	eoa
	)

H5Fget_file_image()

H5_DLL ssize_t H5Fget_file_image	(	hid_t	file_id,
		void *	buf_ptr,
		size_t	buf_len
	)

H5Fget_fileno()

H5_DLL herr_t H5Fget_fileno	(	hid_t	file_id,
		unsigned long *	fileno
	)

H5Fget_filesize()

H5_DLL herr_t H5Fget_filesize	(	hid_t	file_id,
		hsize_t *	size
	)

H5Fget_free_sections()

H5_DLL ssize_t H5Fget_free_sections	(	hid_t	file_id,
		H5F_mem_t	type,
		size_t	nsects,
		H5F_sect_info_t *	sect_info
	)

H5Fget_freespace()

H5_DLL hssize_t H5Fget_freespace

(

hid_t

file_id

)

H5Fget_info1()

H5_DLL herr_t H5Fget_info1	(	hid_t	obj_id,
		H5F_info1_t *	finfo
	)

H5Fget_info2()

H5_DLL herr_t H5Fget_info2	(	hid_t	obj_id,
		H5F_info2_t *	finfo
	)

H5Fget_intent()

H5_DLL herr_t H5Fget_intent	(	hid_t	file_id,
		unsigned *	intent
	)

H5Fget_mdc_config()

H5_DLL herr_t H5Fget_mdc_config	(	hid_t	file_id,
		H5AC_cache_config_t *	config_ptr
	)

H5Fget_mdc_hit_rate()

H5_DLL herr_t H5Fget_mdc_hit_rate	(	hid_t	file_id,
		double *	hit_rate_ptr
	)

H5Fget_mdc_image_info()

H5_DLL herr_t H5Fget_mdc_image_info	(	hid_t	file_id,
		haddr_t *	image_addr,
		hsize_t *	image_size
	)

H5Fget_mdc_logging_status()

H5_DLL herr_t H5Fget_mdc_logging_status	(	hid_t	file_id,
		hbool_t *	is_enabled,
		hbool_t *	is_currently_logging
	)

H5Fget_mdc_size()

H5_DLL herr_t H5Fget_mdc_size	(	hid_t	file_id,
		size_t *	max_size_ptr,
		size_t *	min_clean_size_ptr,
		size_t *	cur_size_ptr,
		int *	cur_num_entries_ptr
	)

H5Fget_metadata_read_retry_info()

H5_DLL herr_t H5Fget_metadata_read_retry_info	(	hid_t	file_id,
		H5F_retry_info_t *	info
	)

H5Fget_name()

H5_DLL ssize_t H5Fget_name	(	hid_t	obj_id,
		char *	name,
		size_t	size
	)

H5Fget_obj_count()

H5_DLL ssize_t H5Fget_obj_count	(	hid_t	file_id,
		unsigned	types
	)

H5Fget_obj_ids()

H5_DLL ssize_t H5Fget_obj_ids	(	hid_t	file_id,
		unsigned	types,
		size_t	max_objs,
		hid_t *	obj_id_list
	)

H5Fget_page_buffering_stats()

H5_DLL herr_t H5Fget_page_buffering_stats	(	hid_t	file_id,
		unsigned	accesses[2],
		unsigned	hits[2],
		unsigned	misses[2],
		unsigned	evictions[2],
		unsigned	bypasses[2]
	)

H5Fget_vfd_handle()

H5_DLL herr_t H5Fget_vfd_handle	(	hid_t	file_id,
		hid_t	fapl,
		void **	file_handle
	)

H5Fincrement_filesize()

H5_DLL herr_t H5Fincrement_filesize	(	hid_t	file_id,
		hsize_t	increment
	)

H5Fis_accessible()

H5_DLL htri_t H5Fis_accessible	(	const char *	container_name,
		hid_t	fapl_id
	)

H5Fis_hdf5()

H5_DLL htri_t H5Fis_hdf5

(

const char *

filename

)

H5Fmount()

H5_DLL herr_t H5Fmount	(	hid_t	loc,
		const char *	name,
		hid_t	child,
		hid_t	plist
	)

H5Fopen()

H5_DLL hid_t H5Fopen	(	const char *	filename,
		unsigned	flags,
		hid_t	access_plist
	)

H5Freopen()

H5_DLL hid_t H5Freopen

(

hid_t

file_id

)

H5Freset_mdc_hit_rate_stats()

H5_DLL herr_t H5Freset_mdc_hit_rate_stats

(

hid_t

file_id

)

H5Freset_page_buffering_stats()

H5_DLL herr_t H5Freset_page_buffering_stats

(

hid_t

file_id

)

H5Fset_dset_no_attrs_hint()

H5_DLL herr_t H5Fset_dset_no_attrs_hint	(	hid_t	file_id,
		hbool_t	minimize
	)

H5Fset_latest_format()

H5_DLL herr_t H5Fset_latest_format	(	hid_t	file_id,
		hbool_t	latest_format
	)

H5Fset_libver_bounds()

H5_DLL herr_t H5Fset_libver_bounds	(	hid_t	file_id,
		H5F_libver_t	low,
		H5F_libver_t	high
	)

H5Fset_mdc_config()

H5_DLL herr_t H5Fset_mdc_config	(	hid_t	file_id,
		H5AC_cache_config_t *	config_ptr
	)

H5Fstart_mdc_logging()

H5_DLL herr_t H5Fstart_mdc_logging

(

hid_t

file_id

)

H5Fstart_swmr_write()

H5_DLL herr_t H5Fstart_swmr_write

(

hid_t

file_id

)

H5Fstop_mdc_logging()

H5_DLL herr_t H5Fstop_mdc_logging

(

hid_t

file_id

)

H5Funmount()

H5_DLL herr_t H5Funmount	(	hid_t	loc,
		const char *	name
	)