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

Data Structures
struct	H5F_info_t

Macros
#define	H5CHECK H5check(),

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

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

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

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

#define	H5F_ACC_DEBUG (H5CHECK 0x0000u) /print debug info (no longer used) /

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

#define	H5F_ACC_DEFAULT (H5CHECK 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_18 H5F_LIBVER_LATEST

Typedefs
typedef enum H5F_scope_t	H5F_scope_t

typedef enum H5F_close_degree_t	H5F_close_degree_t

typedef struct H5F_info_t	H5F_info_t

typedef enum H5F_mem_t	H5F_mem_t

typedef enum H5F_libver_t	H5F_libver_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_EARLIEST, H5F_LIBVER_LATEST }

Functions
H5_DLL htri_t	H5Fis_hdf5 (const char *filename)

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 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 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 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_info (hid_t obj_id, H5F_info_t *bh_info)

H5_DLL herr_t	H5Fclear_elink_file_cache (hid_t file_id)

Macro Definition Documentation

◆ H5CHECK

#define H5CHECK H5check(),

Definition at line 28 of file H5Fpublic.h.

◆ H5F_ACC_CREAT

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

Definition at line 50 of file H5Fpublic.h.

◆ H5F_ACC_DEBUG

#define H5F_ACC_DEBUG (H5CHECK 0x0000u) /*print debug info (no longer used) */

Definition at line 49 of file H5Fpublic.h.

◆ H5F_ACC_DEFAULT

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

Definition at line 54 of file H5Fpublic.h.

◆ H5F_ACC_EXCL

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

Definition at line 48 of file H5Fpublic.h.

◆ H5F_ACC_RDONLY

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

Definition at line 45 of file H5Fpublic.h.

◆ H5F_ACC_RDWR

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

Definition at line 46 of file H5Fpublic.h.

◆ H5F_ACC_TRUNC

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

Definition at line 47 of file H5Fpublic.h.

◆ H5F_FAMILY_DEFAULT

#define H5F_FAMILY_DEFAULT (hsize_t)0

Definition at line 66 of file H5Fpublic.h.

◆ H5F_LIBVER_18

#define H5F_LIBVER_18 H5F_LIBVER_LATEST

Definition at line 147 of file H5Fpublic.h.

◆ H5F_OBJ_ALL

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

Definition at line 62 of file H5Fpublic.h.

◆ H5F_OBJ_ATTR

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

Definition at line 61 of file H5Fpublic.h.

◆ H5F_OBJ_DATASET

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

Definition at line 58 of file H5Fpublic.h.

◆ H5F_OBJ_DATATYPE

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

Definition at line 60 of file H5Fpublic.h.

◆ H5F_OBJ_FILE

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

Definition at line 57 of file H5Fpublic.h.

◆ H5F_OBJ_GROUP

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

Definition at line 59 of file H5Fpublic.h.

◆ H5F_OBJ_LOCAL

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

Definition at line 63 of file H5Fpublic.h.

◆ H5F_UNLIMITED

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

Definition at line 85 of file H5Fpublic.h.

Typedef Documentation

◆ H5F_close_degree_t

typedef enum H5F_close_degree_t H5F_close_degree_t

◆ H5F_info_t

typedef struct H5F_info_t H5F_info_t

◆ H5F_libver_t

typedef enum H5F_libver_t H5F_libver_t

◆ H5F_mem_t

typedef enum H5F_mem_t H5F_mem_t

◆ H5F_scope_t

typedef enum H5F_scope_t H5F_scope_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

Definition at line 95 of file H5Fpublic.h.

◆ H5F_libver_t

enum H5F_libver_t

Enumerator
H5F_LIBVER_EARLIEST
H5F_LIBVER_LATEST

Definition at line 140 of file H5Fpublic.h.

◆ 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

Definition at line 120 of file H5Fpublic.h.

◆ H5F_scope_t

enum H5F_scope_t

Enumerator
H5F_SCOPE_LOCAL
H5F_SCOPE_GLOBAL

Definition at line 79 of file H5Fpublic.h.

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
	)

◆ H5Fflush()

H5_DLL herr_t H5Fflush	(	hid_t	object_id,
		H5F_scope_t	scope
	)

◆ 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_file_image()

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

◆ H5Fget_filesize()

H5_DLL herr_t H5Fget_filesize	(	hid_t	file_id,
		hsize_t *	size
	)

◆ H5Fget_freespace()

H5_DLL hssize_t H5Fget_freespace ( hid_t file_id )

◆ H5Fget_info()

H5_DLL herr_t H5Fget_info	(	hid_t	obj_id,
		H5F_info_t *	bh_info
	)

◆ 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_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_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_vfd_handle()

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

◆ 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 )

◆ H5Fset_mdc_config()

H5_DLL herr_t H5Fset_mdc_config	(	hid_t	file_id,
		H5AC_cache_config_t *	config_ptr
	)

◆ H5Funmount()

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

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ H5CHECK

◆ H5F_ACC_CREAT

◆ H5F_ACC_DEBUG

◆ H5F_ACC_DEFAULT

◆ H5F_ACC_EXCL

◆ H5F_ACC_RDONLY

◆ H5F_ACC_RDWR

◆ H5F_ACC_TRUNC

◆ H5F_FAMILY_DEFAULT

◆ H5F_LIBVER_18

◆ H5F_OBJ_ALL

◆ H5F_OBJ_ATTR

◆ H5F_OBJ_DATASET

◆ H5F_OBJ_DATATYPE

◆ H5F_OBJ_FILE

◆ H5F_OBJ_GROUP

◆ H5F_OBJ_LOCAL

◆ H5F_UNLIMITED

Typedef Documentation

◆ H5F_close_degree_t

◆ H5F_info_t

◆ H5F_libver_t

◆ H5F_mem_t

◆ H5F_scope_t

Enumeration Type Documentation

◆ H5F_close_degree_t

◆ H5F_libver_t

◆ H5F_mem_t

◆ H5F_scope_t

Function Documentation

◆ H5Fclear_elink_file_cache()

◆ H5Fclose()

◆ H5Fcreate()

◆ H5Fflush()

◆ H5Fget_access_plist()

◆ H5Fget_create_plist()

◆ H5Fget_file_image()

◆ H5Fget_filesize()

◆ H5Fget_freespace()

◆ H5Fget_info()

◆ H5Fget_intent()

◆ H5Fget_mdc_config()

◆ H5Fget_mdc_hit_rate()

◆ H5Fget_mdc_size()

◆ H5Fget_name()

◆ H5Fget_obj_count()

◆ H5Fget_obj_ids()

◆ H5Fget_vfd_handle()

◆ H5Fis_hdf5()

◆ H5Fmount()

◆ H5Fopen()

◆ H5Freopen()

◆ H5Freset_mdc_hit_rate_stats()

◆ H5Fset_mdc_config()

◆ H5Funmount()