 |
HDF5
1.15.0
APIReference
|
|
|
HDF5
1.15.0
APIReference
|
|
Data Structures | |
| struct | H5F_info2_t |
| struct | H5F_sect_info_t |
| struct | H5F_retry_info_t |
| struct | H5F_info1_t |
Typedefs | |
| typedef herr_t(* | H5F_flush_cb_t) (hid_t object_id, void *udata) |
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_V114 = 4, H5F_LIBVER_V116 = 5, H5F_LIBVER_NBOUNDS } |
| enum | H5F_fspace_strategy_t { H5F_FSPACE_STRATEGY_FSM_AGGR = 0, H5F_FSPACE_STRATEGY_PAGE, 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 | |
| htri_t | H5Fis_accessible (const char *container_name, hid_t fapl_id) |
| Checks if a file can be opened with a given file access property list. More... | |
| hid_t | H5Fcreate (const char *filename, unsigned flags, hid_t fcpl_id, hid_t fapl_id) |
| Creates an HDF5 file. More... | |
| hid_t | H5Fcreate_async (const char *filename, unsigned flags, hid_t fcpl_id, hid_t fapl_id, hid_t es_id) |
| hid_t | H5Fopen (const char *filename, unsigned flags, hid_t fapl_id) |
| Opens an existing HDF5 file. More... | |
| hid_t | H5Fopen_async (const char *filename, unsigned flags, hid_t access_plist, hid_t es_id) |
| hid_t | H5Freopen (hid_t file_id) |
| Returns a new identifier for a previously-opened HDF5 file. More... | |
| hid_t | H5Freopen_async (hid_t file_id, hid_t es_id) |
| herr_t | H5Fflush (hid_t object_id, H5F_scope_t scope) |
| Flushes all buffers associated with a file to storage. More... | |
| herr_t | H5Fflush_async (hid_t object_id, H5F_scope_t scope, hid_t es_id) |
| herr_t | H5Fclose (hid_t file_id) |
| Terminates access to an HDF5 file. More... | |
| herr_t | H5Fclose_async (hid_t file_id, hid_t es_id) |
| herr_t | H5Fdelete (const char *filename, hid_t fapl_id) |
| Deletes an HDF5 file. More... | |
| hid_t | H5Fget_create_plist (hid_t file_id) |
| Returns a file creation property list identifier. More... | |
| hid_t | H5Fget_access_plist (hid_t file_id) |
| Returns a file access property list identifier. More... | |
| herr_t | H5Fget_intent (hid_t file_id, unsigned *intent) |
| Determines the read/write or read-only status of a file. More... | |
| herr_t | H5Fget_fileno (hid_t file_id, unsigned long *fileno) |
| Retrieves a file's file number that uniquely identifies an open file. More... | |
| ssize_t | H5Fget_obj_count (hid_t file_id, unsigned types) |
| Returns the number of open object identifiers for an open file. More... | |
| ssize_t | H5Fget_obj_ids (hid_t file_id, unsigned types, size_t max_objs, hid_t *obj_id_list) |
| Returns a list of open object identifiers. More... | |
| herr_t | H5Fget_vfd_handle (hid_t file_id, hid_t fapl, void **file_handle) |
| Returns pointer to the file handle from the virtual file driver. More... | |
| herr_t | H5Fmount (hid_t loc, const char *name, hid_t child, hid_t plist) |
| Mounts an HDF5 file. More... | |
| herr_t | H5Funmount (hid_t loc, const char *name) |
| Unounts an HDF5 file. More... | |
| hssize_t | H5Fget_freespace (hid_t file_id) |
| Returns the amount of free space in a file (in bytes) More... | |
| herr_t | H5Fget_filesize (hid_t file_id, hsize_t *size) |
| Returns the size of an HDF5 file (in bytes) More... | |
| herr_t | H5Fget_eoa (hid_t file_id, haddr_t *eoa) |
| Retrieves the file's end-of-allocation (EOA) More... | |
| herr_t | H5Fincrement_filesize (hid_t file_id, hsize_t increment) |
| Sets the file' EOA to the maximum of (EOA, EOF) + increment. More... | |
| ssize_t | H5Fget_file_image (hid_t file_id, void *buf_ptr, size_t buf_len) |
| Retrieves a copy of the image of an existing, open file. More... | |
| herr_t | H5Fget_mdc_config (hid_t file_id, H5AC_cache_config_t *config_ptr) |
| Obtains current metadata cache configuration for target file. More... | |
| herr_t | H5Fset_mdc_config (hid_t file_id, const H5AC_cache_config_t *config_ptr) |
| Attempts to configure metadata cache of target file. More... | |
| herr_t | H5Fget_mdc_hit_rate (hid_t file_id, double *hit_rate_ptr) |
| Obtains target file's metadata cache hit rate. More... | |
| 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) |
| Obtains current metadata cache size data for specified file. More... | |
| herr_t | H5Freset_mdc_hit_rate_stats (hid_t file_id) |
| Resets hit rate statistics counters for the target file. More... | |
| ssize_t | H5Fget_name (hid_t obj_id, char *name, size_t size) |
| Retrieves name of file to which object belongs. More... | |
| herr_t | H5Fget_info2 (hid_t obj_id, H5F_info2_t *file_info) |
| Retrieves global file information. More... | |
| herr_t | H5Fget_metadata_read_retry_info (hid_t file_id, H5F_retry_info_t *info) |
| Retrieves the collection of read retries for metadata entries with checksum. More... | |
| herr_t | H5Fstart_swmr_write (hid_t file_id) |
| Retrieves free-space section information for a file. More... | |
| ssize_t | H5Fget_free_sections (hid_t file_id, H5F_mem_t type, size_t nsects, H5F_sect_info_t *sect_info) |
| Retrieves free-space section information for a file. More... | |
| herr_t | H5Fclear_elink_file_cache (hid_t file_id) |
| Clears the external link open file cache. More... | |
| herr_t | H5Fset_libver_bounds (hid_t file_id, H5F_libver_t low, H5F_libver_t high) |
| Enables the switch of version bounds setting for a file. More... | |
| herr_t | H5Fstart_mdc_logging (hid_t file_id) |
| Starts logging metadata cache events if logging was previously enabled. More... | |
| herr_t | H5Fstop_mdc_logging (hid_t file_id) |
| Stops logging metadata cache events if logging was previously enabled and is currently ongoing. More... | |
| herr_t | H5Fget_mdc_logging_status (hid_t file_id, hbool_t *is_enabled, hbool_t *is_currently_logging) |
| Gets the current metadata cache logging status. More... | |
| herr_t | H5Freset_page_buffering_stats (hid_t file_id) |
| Resets the page buffer statistics. More... | |
| 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]) |
| Retrieves statistics about page access when it is enabled. More... | |
| herr_t | H5Fget_mdc_image_info (hid_t file_id, haddr_t *image_addr, hsize_t *image_size) |
| Obtains information about a cache image if it exists. More... | |
| herr_t | H5Fget_dset_no_attrs_hint (hid_t file_id, hbool_t *minimize) |
| Retrieves the setting for whether or not a file will create minimized dataset object headers. More... | |
| herr_t | H5Fset_dset_no_attrs_hint (hid_t file_id, hbool_t minimize) |
| Sets the flag to create minimized dataset object headers. More... | |
| herr_t | H5Fset_mpi_atomicity (hid_t file_id, hbool_t flag) |
| Sets the MPI atomicity mode. More... | |
| herr_t | H5Fget_mpi_atomicity (hid_t file_id, hbool_t *flag) |
| Retrieves the atomicity mode in use. More... | |
| herr_t | H5Fget_info1 (hid_t obj_id, H5F_info1_t *file_info) |
| Retrieves global file information. More... | |
| herr_t | H5Fset_latest_format (hid_t file_id, hbool_t latest_format) |
| Sets the latest version of the library to be used for writing objects. More... | |
| htri_t | H5Fis_hdf5 (const char *file_name) |
| Determines whether a file is in the HDF5 format. More... | |
| #define H5CHECK H5check(), |
Print debug info
| #define H5F_ACC_SWMR_READ (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 H5F_ACC_RDONLY flag.
| #define H5F_ACC_SWMR_WRITE (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 H5F_ACC_RDONLY and use the \ H5F_ACC_SWMR_READ access flag.
| #define H5F_FAMILY_DEFAULT 0 /* (hsize_t) */ |
| #define H5F_LIBVER_LATEST H5F_LIBVER_V116 |
| #define H5F_MPIO_DEBUG_KEY "H5F_mpio_debug_key" |
Use this constant string as the MPI_Info key to set H5Fmpio debug flags. To turn on H5Fmpio debug flags, set the MPI_Info value with this key to have the value of a string consisting of the characters that turn on the desired flags.
| #define H5F_NUM_METADATA_READ_RETRY_TYPES 21 |
| #define H5F_OBJ_ALL (H5F_OBJ_FILE | H5F_OBJ_DATASET | H5F_OBJ_GROUP | H5F_OBJ_DATATYPE | H5F_OBJ_ATTR) |
| #define H5F_OBJ_ATTR (0x0010u) |
Attribute objects
| #define H5F_OBJ_DATASET (0x0002u) |
Dataset objects
| #define H5F_OBJ_DATATYPE (0x0008u) |
Datatype objects
| #define H5F_OBJ_FILE (0x0001u) |
File objects
| #define H5F_OBJ_GROUP (0x0004u) |
Group objects
| #define H5F_OBJ_LOCAL (0x0020u) |
Restrict search to objects opened through current file ID \ (as opposed to objects opened through any file ID accessing this file)
| #define H5F_RFIC_ALL (H5F_RFIC_UNUSUAL_NUM_UNUSED_NUMERIC_BITS) |
Suppress all format integrity check errors. See \ documentation for H5Pset_relax_file_integrity_checks \ for details.
| #define H5F_RFIC_UNUSUAL_NUM_UNUSED_NUMERIC_BITS (0x0001u) |
Suppress errors for numeric datatypes with an unusually \ high number of unused bits. See documentation for \ H5Pset_relax_file_integrity_checks for details.
| #define H5F_UNLIMITED HSIZE_UNDEF |
Unlimited file size for H5Pset_external()
| #define H5OPEN H5open(), |
Callback for H5Pset_object_flush_cb() in a file access property list
| enum H5F_close_degree_t |
How does file close behave?
File space handling strategy for release 1.10.0
File space handling strategy
| enum H5F_libver_t |
Library's format versions
| enum H5F_mem_t |
Types of allocation requests. The values larger than H5FD_MEM_DEFAULT should not change other than adding new types to the end. These numbers might appear in files.
| enum H5F_scope_t |
The scope of an operation such as H5Fflush(), e.g., a single file vs. a set of mounted files
| Enumerator | |
|---|---|
| H5F_SCOPE_LOCAL | The specified file handle only |
| H5F_SCOPE_GLOBAL | The entire virtual file |
1.8.18