HDF5  1.12.0
H5Fpublic.h File Reference

Data Structures

struct  H5F_info2_t
 
struct  H5F_sect_info_t
 
struct  H5F_retry_info_t
 
struct  H5F_info1_t
 

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 H5Fset_mpi_atomicity (hid_t file_id, hbool_t flag)
 
H5_DLL herr_t H5Fget_mpi_atomicity (hid_t file_id, hbool_t *flag)
 
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)
 

Typedef Documentation

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

◆ 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

◆ H5F_scope_t

typedef enum H5F_scope_t H5F_scope_t

◆ H5F_sect_info_t

Enumeration Type Documentation

◆ H5F_close_degree_t

Enumerator
H5F_CLOSE_DEFAULT 
H5F_CLOSE_WEAK 
H5F_CLOSE_SEMI 
H5F_CLOSE_STRONG 

◆ 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

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

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

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

◆ H5Fdelete()

◆ H5Fflush()

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

◆ H5Fget_info2()

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

H5_DLL herr_t H5Fget_mpi_atomicity ( hid_t  file_id,
hbool_t flag 
)

◆ H5Fget_name()

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

◆ H5Fget_obj_count()

◆ H5Fget_obj_ids()

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

◆ H5Fopen()

◆ H5Freopen()

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

◆ H5Fset_mpi_atomicity()

H5_DLL herr_t H5Fset_mpi_atomicity ( hid_t  file_id,
hbool_t  flag 
)

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