Please, help us to better know about our user community by answering the following short survey: https://www.hdfgroup.org/
HDF5  1.12.1
H5Ppublic.h File Reference
#include "H5public.h"
#include "H5ACpublic.h"
#include "H5Dpublic.h"
#include "H5Fpublic.h"
#include "H5FDpublic.h"
#include "H5Ipublic.h"
#include "H5Lpublic.h"
#include "H5Opublic.h"
#include "H5MMpublic.h"
#include "H5Tpublic.h"
#include "H5Zpublic.h"

Macros

#define H5OPEN   H5open(),
 
#define H5P_ROOT   (H5OPEN H5P_CLS_ROOT_ID_g)
 
#define H5P_OBJECT_CREATE   (H5OPEN H5P_CLS_OBJECT_CREATE_ID_g)
 
#define H5P_FILE_CREATE   (H5OPEN H5P_CLS_FILE_CREATE_ID_g)
 
#define H5P_FILE_ACCESS   (H5OPEN H5P_CLS_FILE_ACCESS_ID_g)
 
#define H5P_DATASET_CREATE   (H5OPEN H5P_CLS_DATASET_CREATE_ID_g)
 
#define H5P_DATASET_ACCESS   (H5OPEN H5P_CLS_DATASET_ACCESS_ID_g)
 
#define H5P_DATASET_XFER   (H5OPEN H5P_CLS_DATASET_XFER_ID_g)
 
#define H5P_FILE_MOUNT   (H5OPEN H5P_CLS_FILE_MOUNT_ID_g)
 
#define H5P_GROUP_CREATE   (H5OPEN H5P_CLS_GROUP_CREATE_ID_g)
 
#define H5P_GROUP_ACCESS   (H5OPEN H5P_CLS_GROUP_ACCESS_ID_g)
 
#define H5P_DATATYPE_CREATE   (H5OPEN H5P_CLS_DATATYPE_CREATE_ID_g)
 
#define H5P_DATATYPE_ACCESS   (H5OPEN H5P_CLS_DATATYPE_ACCESS_ID_g)
 
#define H5P_MAP_CREATE   (H5OPEN H5P_CLS_MAP_CREATE_ID_g)
 
#define H5P_MAP_ACCESS   (H5OPEN H5P_CLS_MAP_ACCESS_ID_g)
 
#define H5P_STRING_CREATE   (H5OPEN H5P_CLS_STRING_CREATE_ID_g)
 
#define H5P_ATTRIBUTE_CREATE   (H5OPEN H5P_CLS_ATTRIBUTE_CREATE_ID_g)
 
#define H5P_ATTRIBUTE_ACCESS   (H5OPEN H5P_CLS_ATTRIBUTE_ACCESS_ID_g)
 
#define H5P_OBJECT_COPY   (H5OPEN H5P_CLS_OBJECT_COPY_ID_g)
 
#define H5P_LINK_CREATE   (H5OPEN H5P_CLS_LINK_CREATE_ID_g)
 
#define H5P_LINK_ACCESS   (H5OPEN H5P_CLS_LINK_ACCESS_ID_g)
 
#define H5P_VOL_INITIALIZE   (H5OPEN H5P_CLS_VOL_INITIALIZE_ID_g)
 
#define H5P_REFERENCE_ACCESS   (H5OPEN H5P_CLS_REFERENCE_ACCESS_ID_g)
 
#define H5P_FILE_CREATE_DEFAULT   (H5OPEN H5P_LST_FILE_CREATE_ID_g)
 
#define H5P_FILE_ACCESS_DEFAULT   (H5OPEN H5P_LST_FILE_ACCESS_ID_g)
 
#define H5P_DATASET_CREATE_DEFAULT   (H5OPEN H5P_LST_DATASET_CREATE_ID_g)
 
#define H5P_DATASET_ACCESS_DEFAULT   (H5OPEN H5P_LST_DATASET_ACCESS_ID_g)
 
#define H5P_DATASET_XFER_DEFAULT   (H5OPEN H5P_LST_DATASET_XFER_ID_g)
 
#define H5P_FILE_MOUNT_DEFAULT   (H5OPEN H5P_LST_FILE_MOUNT_ID_g)
 
#define H5P_GROUP_CREATE_DEFAULT   (H5OPEN H5P_LST_GROUP_CREATE_ID_g)
 
#define H5P_GROUP_ACCESS_DEFAULT   (H5OPEN H5P_LST_GROUP_ACCESS_ID_g)
 
#define H5P_DATATYPE_CREATE_DEFAULT   (H5OPEN H5P_LST_DATATYPE_CREATE_ID_g)
 
#define H5P_DATATYPE_ACCESS_DEFAULT   (H5OPEN H5P_LST_DATATYPE_ACCESS_ID_g)
 
#define H5P_MAP_CREATE_DEFAULT   (H5OPEN H5P_LST_MAP_CREATE_ID_g)
 
#define H5P_MAP_ACCESS_DEFAULT   (H5OPEN H5P_LST_MAP_ACCESS_ID_g)
 
#define H5P_ATTRIBUTE_CREATE_DEFAULT   (H5OPEN H5P_LST_ATTRIBUTE_CREATE_ID_g)
 
#define H5P_ATTRIBUTE_ACCESS_DEFAULT   (H5OPEN H5P_LST_ATTRIBUTE_ACCESS_ID_g)
 
#define H5P_OBJECT_COPY_DEFAULT   (H5OPEN H5P_LST_OBJECT_COPY_ID_g)
 
#define H5P_LINK_CREATE_DEFAULT   (H5OPEN H5P_LST_LINK_CREATE_ID_g)
 
#define H5P_LINK_ACCESS_DEFAULT   (H5OPEN H5P_LST_LINK_ACCESS_ID_g)
 
#define H5P_VOL_INITIALIZE_DEFAULT   (H5OPEN H5P_LST_VOL_INITIALIZE_ID_g)
 
#define H5P_REFERENCE_ACCESS_DEFAULT   (H5OPEN H5P_LST_REFERENCE_ACCESS_ID_g)
 
#define H5P_CRT_ORDER_TRACKED   0x0001
 
#define H5P_CRT_ORDER_INDEXED   0x0002
 
#define H5P_DEFAULT   (hid_t)0
 
#define H5P_NO_CLASS   H5P_ROOT
 

Typedefs

typedef herr_t(* H5P_cls_create_func_t) (hid_t prop_id, void *create_data)
 
typedef herr_t(* H5P_cls_copy_func_t) (hid_t new_prop_id, hid_t old_prop_id, void *copy_data)
 
typedef herr_t(* H5P_cls_close_func_t) (hid_t prop_id, void *close_data)
 
typedef herr_t(* H5P_prp_cb1_t) (const char *name, size_t size, void *value)
 Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1() More...
 
typedef herr_t(* H5P_prp_cb2_t) (hid_t prop_id, const char *name, size_t size, void *value)
 Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1() More...
 
typedef H5P_prp_cb1_t H5P_prp_create_func_t
 
typedef H5P_prp_cb2_t H5P_prp_set_func_t
 
typedef H5P_prp_cb2_t H5P_prp_get_func_t
 
typedef herr_t(* H5P_prp_encode_func_t) (const void *value, void **buf, size_t *size)
 
typedef herr_t(* H5P_prp_decode_func_t) (const void **buf, void *value)
 
typedef H5P_prp_cb2_t H5P_prp_delete_func_t
 
typedef H5P_prp_cb1_t H5P_prp_copy_func_t
 
typedef int(* H5P_prp_compare_func_t) (const void *value1, const void *value2, size_t size)
 
typedef H5P_prp_cb1_t H5P_prp_close_func_t
 
typedef herr_t(* H5P_iterate_t) (hid_t id, const char *name, void *iter_data)
 

Enumerations

enum  H5D_mpio_actual_chunk_opt_mode_t { H5D_MPIO_NO_CHUNK_OPTIMIZATION = 0, H5D_MPIO_LINK_CHUNK, H5D_MPIO_MULTI_CHUNK }
 
enum  H5D_mpio_actual_io_mode_t {
  H5D_MPIO_NO_COLLECTIVE = 0x0, H5D_MPIO_CHUNK_INDEPENDENT = 0x1, H5D_MPIO_CHUNK_COLLECTIVE = 0x2, H5D_MPIO_CHUNK_MIXED = 0x1 | 0x2,
  H5D_MPIO_CONTIGUOUS_COLLECTIVE = 0x4
}
 
enum  H5D_mpio_no_collective_cause_t {
  H5D_MPIO_COLLECTIVE = 0x00, H5D_MPIO_SET_INDEPENDENT = 0x01, H5D_MPIO_DATATYPE_CONVERSION = 0x02, H5D_MPIO_DATA_TRANSFORMS = 0x04,
  H5D_MPIO_MPI_OPT_TYPES_ENV_VAR_DISABLED = 0x08, H5D_MPIO_NOT_SIMPLE_OR_SCALAR_DATASPACES = 0x10, H5D_MPIO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET = 0x20, H5D_MPIO_PARALLEL_FILTERED_WRITES_DISABLED = 0x40,
  H5D_MPIO_ERROR_WHILE_CHECKING_COLLECTIVE_POSSIBLE = 0x80, H5D_MPIO_NO_COLLECTIVE_MAX_CAUSE = 0x100
}
 

Functions

herr_t H5Pclose (hid_t plist_id)
 Terminates access to a property list. More...
 
herr_t H5Pclose_class (hid_t plist_id)
 Closes an existing property list class. More...
 
hid_t H5Pcopy (hid_t plist_id)
 Copies an existing property list to create a new property list. More...
 
herr_t H5Pcopy_prop (hid_t dst_id, hid_t src_id, const char *name)
 Copies a property from one list or class to another. More...
 
hid_t H5Pcreate (hid_t cls_id)
 Creates a new property list as an instance of a property list class. More...
 
hid_t H5Pcreate_class (hid_t parent, const char *name, H5P_cls_create_func_t create, void *create_data, H5P_cls_copy_func_t copy, void *copy_data, H5P_cls_close_func_t close, void *close_data)
 Creates a new property list class. More...
 
hid_t H5Pdecode (const void *buf)
 Decodes property list received in a binary object buffer and returns a new property list identifier. More...
 
herr_t H5Pencode2 (hid_t plist_id, void *buf, size_t *nalloc, hid_t fapl_id)
 Encodes the property values in a property list into a binary buffer. More...
 
htri_t H5Pequal (hid_t id1, hid_t id2)
 Compares two property lists or classes for equality. More...
 
htri_t H5Pexist (hid_t plist_id, const char *name)
 Queries whether a property name exists in a property list or class. More...
 
herr_t H5Pget (hid_t plist_id, const char *name, void *value)
 Queries the value of a property. More...
 
hid_t H5Pget_class (hid_t plist_id)
 Returns the property list class identifier for a property list. More...
 
char * H5Pget_class_name (hid_t pclass_id)
 Retrieves the name of a class. More...
 
hid_t H5Pget_class_parent (hid_t pclass_id)
 Retrieves the parent class of a property class. More...
 
herr_t H5Pget_nprops (hid_t id, size_t *nprops)
 Queries the number of properties in a property list or class. More...
 
herr_t H5Pget_size (hid_t id, const char *name, size_t *size)
 Queries the size of a property value in bytes. More...
 
herr_t H5Pinsert2 (hid_t plist_id, const char *name, size_t size, void *value, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close)
 Registers a temporary property with a property list. More...
 
htri_t H5Pisa_class (hid_t plist_id, hid_t pclass_id)
 Determines whether a property list is a member of a class. More...
 
int H5Piterate (hid_t id, int *idx, H5P_iterate_t iter_func, void *iter_data)
 Iterates over properties in a property class or list. More...
 
herr_t H5Pregister2 (hid_t cls_id, const char *name, size_t size, void *def_value, H5P_prp_create_func_t create, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close)
 Registers a permanent property with a property list class. More...
 
herr_t H5Premove (hid_t plist_id, const char *name)
 Removes a property from a property list. More...
 
herr_t H5Pset (hid_t plist_id, const char *name, const void *value)
 Sets a property list value. More...
 
herr_t H5Punregister (hid_t pclass_id, const char *name)
 Removes a property from a property list class. More...
 
htri_t H5Pall_filters_avail (hid_t plist_id)
 Verifies that all required filters are available. More...
 
herr_t H5Pget_attr_creation_order (hid_t plist_id, unsigned *crt_order_flags)
 Retrieves tracking and indexing settings for attribute creation order. More...
 
herr_t H5Pget_attr_phase_change (hid_t plist_id, unsigned *max_compact, unsigned *min_dense)
 Retrieves attribute storage phase change thresholds. More...
 
H5Z_filter_t H5Pget_filter2 (hid_t plist_id, unsigned idx, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[], unsigned *filter_config)
 Returns information about a filter in a pipeline. More...
 
herr_t H5Pget_filter_by_id2 (hid_t plist_id, H5Z_filter_t filter_id, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[], unsigned *filter_config)
 Returns information about the specified filter. More...
 
int H5Pget_nfilters (hid_t plist_id)
 Returns the number of filters in the pipeline. More...
 
herr_t H5Pget_obj_track_times (hid_t plist_id, hbool_t *track_times)
 Determines whether times associated with an object are being recorded. More...
 
herr_t H5Pmodify_filter (hid_t plist_id, H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[])
 Modifies a filter in the filter pipeline. More...
 
herr_t H5Premove_filter (hid_t plist_id, H5Z_filter_t filter)
 Delete one or more filters in the filter pipeline. More...
 
herr_t H5Pset_attr_creation_order (hid_t plist_id, unsigned crt_order_flags)
 Sets tracking and indexing of attribute creation order. More...
 
herr_t H5Pset_attr_phase_change (hid_t plist_id, unsigned max_compact, unsigned min_dense)
 Sets attribute storage phase change thresholds. More...
 
herr_t H5Pset_deflate (hid_t plist_id, unsigned level)
 Sets deflate (GNU gzip) compression method and compression level. More...
 
herr_t H5Pset_filter (hid_t plist_id, H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int c_values[])
 Adds a filter to the filter pipeline. More...
 
herr_t H5Pset_fletcher32 (hid_t plist_id)
 Sets up use of the Fletcher32 checksum filter. More...
 
herr_t H5Pset_obj_track_times (hid_t plist_id, hbool_t track_times)
 Sets the recording of times associated with an object. More...
 
herr_t H5Pget_file_space_page_size (hid_t plist_id, hsize_t *fsp_size)
 Retrieves the file space page size for a file creation property list. More...
 
herr_t H5Pget_file_space_strategy (hid_t plist_id, H5F_fspace_strategy_t *strategy, hbool_t *persist, hsize_t *threshold)
 Retrieves the file space handling strategy, persisting free-space condition and threshold value for a file creation property list. More...
 
herr_t H5Pget_istore_k (hid_t plist_id, unsigned *ik)
 Queries the 1/2 rank of an indexed storage B-tree. More...
 
herr_t H5Pget_shared_mesg_index (hid_t plist_id, unsigned index_num, unsigned *mesg_type_flags, unsigned *min_mesg_size)
 Retrieves the configuration settings for a shared message index. More...
 
herr_t H5Pget_shared_mesg_nindexes (hid_t plist_id, unsigned *nindexes)
 Retrieves the number of shared object header message indexes in file creation property list. More...
 
herr_t H5Pget_shared_mesg_phase_change (hid_t plist_id, unsigned *max_list, unsigned *min_btree)
 Retrieves shared object header message phase change information. More...
 
herr_t H5Pget_sizes (hid_t plist_id, size_t *sizeof_addr, size_t *sizeof_size)
 Retrieves the size of the offsets and lengths used in an HDF5 file. More...
 
herr_t H5Pget_sym_k (hid_t plist_id, unsigned *ik, unsigned *lk)
 Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size. More...
 
herr_t H5Pget_userblock (hid_t plist_id, hsize_t *size)
 Retrieves the size of a user block. More...
 
herr_t H5Pset_file_space_page_size (hid_t plist_id, hsize_t fsp_size)
 Sets the file space page size for a file creation property list. More...
 
herr_t H5Pset_file_space_strategy (hid_t plist_id, H5F_fspace_strategy_t strategy, hbool_t persist, hsize_t threshold)
 Sets the file space handling strategy and persisting free-space values for a file creation property list. More...
 
herr_t H5Pset_istore_k (hid_t plist_id, unsigned ik)
 Sets the size of the parameter used to control the B-trees for indexing chunked datasets. More...
 
herr_t H5Pset_shared_mesg_index (hid_t plist_id, unsigned index_num, unsigned mesg_type_flags, unsigned min_mesg_size)
 Configures the specified shared object header message index. More...
 
herr_t H5Pset_shared_mesg_nindexes (hid_t plist_id, unsigned nindexes)
 Sets number of shared object header message indexes. More...
 
herr_t H5Pset_shared_mesg_phase_change (hid_t plist_id, unsigned max_list, unsigned min_btree)
 Sets shared object header message storage phase change thresholds. More...
 
herr_t H5Pset_sizes (hid_t plist_id, size_t sizeof_addr, size_t sizeof_size)
 Sets the byte size of the offsets and lengths used to address objects in an HDF5 file. More...
 
herr_t H5Pset_sym_k (hid_t plist_id, unsigned ik, unsigned lk)
 
herr_t H5Pset_userblock (hid_t plist_id, hsize_t size)
 Sets user block size. More...
 
herr_t H5Pget_alignment (hid_t fapl_id, hsize_t *threshold, hsize_t *alignment)
 Retrieves the current settings for alignment properties from a file access property list. More...
 
herr_t H5Pget_cache (hid_t plist_id, int *mdc_nelmts, size_t *rdcc_nslots, size_t *rdcc_nbytes, double *rdcc_w0)
 Queries the raw data chunk cache parameters. More...
 
herr_t H5Pget_core_write_tracking (hid_t fapl_id, hbool_t *is_enabled, size_t *page_size)
 Gets information about the write tracking feature used by the core VFD. More...
 
hid_t H5Pget_driver (hid_t plist_id)
 Returns low-lever driver identifier. More...
 
const void * H5Pget_driver_info (hid_t plist_id)
 Returns a pointer to file driver information. More...
 
herr_t H5Pget_elink_file_cache_size (hid_t plist_id, unsigned *efc_size)
 Retrieves the size of the external link open file cache. More...
 
herr_t H5Pget_evict_on_close (hid_t fapl_id, hbool_t *evict_on_close)
 Retrieves the file access property list setting that determines whether an HDF5 object will be evicted from the library's metadata cache when it is closed. More...
 
herr_t H5Pget_family_offset (hid_t fapl_id, hsize_t *offset)
 Retrieves a data offset from the file access property list. More...
 
herr_t H5Pget_fclose_degree (hid_t fapl_id, H5F_close_degree_t *degree)
 Returns the file close degree. More...
 
herr_t H5Pget_file_image (hid_t fapl_id, void **buf_ptr_ptr, size_t *buf_len_ptr)
 Retrieves a copy of the file image designated as the initial content and structure of a file. More...
 
herr_t H5Pget_file_image_callbacks (hid_t fapl_id, H5FD_file_image_callbacks_t *callbacks_ptr)
 Retrieves callback routines for working with file images. More...
 
herr_t H5Pget_file_locking (hid_t fapl_id, hbool_t *use_file_locking, hbool_t *ignore_when_disabled)
 Retrieves the file locking property values. More...
 
herr_t H5Pget_gc_references (hid_t fapl_id, unsigned *gc_ref)
 Returns garbage collecting references setting. More...
 
herr_t H5Pget_libver_bounds (hid_t plist_id, H5F_libver_t *low, H5F_libver_t *high)
 Retrieves library version bounds settings that indirectly control the format versions used when creating objects. More...
 
herr_t H5Pget_mdc_config (hid_t plist_id, H5AC_cache_config_t *config_ptr)
 Get the current initial metadata cache configuration from the provided file access property list. More...
 
herr_t H5Pget_mdc_image_config (hid_t plist_id, H5AC_cache_image_config_t *config_ptr)
 Retrieves the metadata cache image configuration values for a file access property list. More...
 
herr_t H5Pget_mdc_log_options (hid_t plist_id, hbool_t *is_enabled, char *location, size_t *location_size, hbool_t *start_on_access)
 Gets metadata cache logging options. More...
 
herr_t H5Pget_meta_block_size (hid_t fapl_id, hsize_t *size)
 Returns the current metadata block size setting. More...
 
herr_t H5Pget_metadata_read_attempts (hid_t plist_id, unsigned *attempts)
 Retrieves the number of read attempts from a file access property list. More...
 
herr_t H5Pget_multi_type (hid_t fapl_id, H5FD_mem_t *type)
 Retrieves type of data property for MULTI driver. More...
 
herr_t H5Pget_object_flush_cb (hid_t plist_id, H5F_flush_cb_t *func, void **udata)
 Retrieves the object flush property values from the file access property list. More...
 
herr_t H5Pget_page_buffer_size (hid_t plist_id, size_t *buf_size, unsigned *min_meta_perc, unsigned *min_raw_perc)
 Retrieves the maximum size for the page buffer and the minimum percentage for metadata and raw data pages. More...
 
herr_t H5Pget_sieve_buf_size (hid_t fapl_id, size_t *size)
 Returns maximum data sieve buffer size. More...
 
herr_t H5Pget_small_data_block_size (hid_t fapl_id, hsize_t *size)
 Retrieves the current small data block size setting. More...
 
herr_t H5Pget_vol_id (hid_t plist_id, hid_t *vol_id)
 Returns the identifier of the current VOL connector. More...
 
herr_t H5Pget_vol_info (hid_t plist_id, void **vol_info)
 Returns a copy of the VOL information for a connector. More...
 
herr_t H5Pset_alignment (hid_t fapl_id, hsize_t threshold, hsize_t alignment)
 Sets alignment properties of a file access property list. More...
 
herr_t H5Pset_cache (hid_t plist_id, int mdc_nelmts, size_t rdcc_nslots, size_t rdcc_nbytes, double rdcc_w0)
 Sets the raw data chunk cache parameters. More...
 
herr_t H5Pset_core_write_tracking (hid_t fapl_id, hbool_t is_enabled, size_t page_size)
 Sets write tracking information for core driver, H5FD_CORE. More...
 
herr_t H5Pset_driver (hid_t plist_id, hid_t driver_id, const void *driver_info)
 Sets a file driver. More...
 
herr_t H5Pset_elink_file_cache_size (hid_t plist_id, unsigned efc_size)
 Sets the number of files that can be held open in an external link open file cache. More...
 
herr_t H5Pset_evict_on_close (hid_t fapl_id, hbool_t evict_on_close)
 Controls the library's behavior of evicting metadata associated with a closed object. More...
 
herr_t H5Pset_family_offset (hid_t fapl_id, hsize_t offset)
 Sets offset property for low-level access to a file in a family of files. More...
 
herr_t H5Pset_fclose_degree (hid_t fapl_id, H5F_close_degree_t degree)
 Sets the file close degree. More...
 
herr_t H5Pset_file_image (hid_t fapl_id, void *buf_ptr, size_t buf_len)
 Sets an initial file image in a memory buffer. More...
 
herr_t H5Pset_file_image_callbacks (hid_t fapl_id, H5FD_file_image_callbacks_t *callbacks_ptr)
 Sets the callbacks for working with file images. More...
 
herr_t H5Pset_file_locking (hid_t fapl_id, hbool_t use_file_locking, hbool_t ignore_when_disabled)
 Sets the file locking property values. More...
 
herr_t H5Pset_gc_references (hid_t fapl_id, unsigned gc_ref)
 Sets garbage collecting references flag. More...
 
herr_t H5Pset_libver_bounds (hid_t plist_id, H5F_libver_t low, H5F_libver_t high)
 Controls the range of library release versions used when creating objects in a file. More...
 
herr_t H5Pset_mdc_config (hid_t plist_id, H5AC_cache_config_t *config_ptr)
 Set the initial metadata cache configuration in the indicated File Access Property List to the supplied value. More...
 
herr_t H5Pset_mdc_log_options (hid_t plist_id, hbool_t is_enabled, const char *location, hbool_t start_on_access)
 Sets metadata cache logging options. More...
 
herr_t H5Pset_meta_block_size (hid_t fapl_id, hsize_t size)
 Sets the minimum metadata block size. More...
 
herr_t H5Pset_metadata_read_attempts (hid_t plist_id, unsigned attempts)
 Sets the number of read attempts in a file access property list. More...
 
herr_t H5Pset_multi_type (hid_t fapl_id, H5FD_mem_t type)
 Specifies type of data to be accessed via the MULTI driver, enabling more direct access. More...
 
herr_t H5Pset_object_flush_cb (hid_t plist_id, H5F_flush_cb_t func, void *udata)
 Sets a callback function to invoke when an object flush occurs in the file. More...
 
herr_t H5Pset_sieve_buf_size (hid_t fapl_id, size_t size)
 Sets the maximum size of the data sieve buffer. More...
 
herr_t H5Pset_small_data_block_size (hid_t fapl_id, hsize_t size)
 Sets the size of a contiguous block reserved for small data. More...
 
herr_t H5Pset_vol (hid_t plist_id, hid_t new_vol_id, const void *new_vol_info)
 Set the file VOL connector for a file access property list. More...
 
herr_t H5Pset_all_coll_metadata_ops (hid_t plist_id, hbool_t is_collective)
 Sets metadata I/O mode for read operations to collective or independent (default) More...
 
herr_t H5Pget_all_coll_metadata_ops (hid_t plist_id, hbool_t *is_collective)
 Retrieves metadata read mode setting. More...
 
herr_t H5Pset_coll_metadata_write (hid_t plist_id, hbool_t is_collective)
 Sets metadata write mode to collective or independent (default) More...
 
herr_t H5Pget_coll_metadata_write (hid_t plist_id, hbool_t *is_collective)
 Retrieves metadata write mode setting. More...
 
herr_t H5Pget_mpi_params (hid_t fapl_id, MPI_Comm *comm, MPI_Info *info)
 
herr_t H5Pset_mpi_params (hid_t fapl_id, MPI_Comm comm, MPI_Info info)
 
herr_t H5Pset_mdc_image_config (hid_t plist_id, H5AC_cache_image_config_t *config_ptr)
 Sets the metadata cache image option for a file access property list. More...
 
herr_t H5Pset_page_buffer_size (hid_t plist_id, size_t buf_size, unsigned min_meta_per, unsigned min_raw_per)
 Sets the maximum size for the page buffer and the minimum percentage for metadata and raw data pages. More...
 
herr_t H5Pfill_value_defined (hid_t plist, H5D_fill_value_t *status)
 Determines whether fill value is defined. More...
 
herr_t H5Pget_alloc_time (hid_t plist_id, H5D_alloc_time_t *alloc_time)
 Retrieves the timing for storage space allocation. More...
 
int H5Pget_chunk (hid_t plist_id, int max_ndims, hsize_t dim[])
 Retrieves the size of chunks for the raw data of a chunked layout dataset. More...
 
herr_t H5Pget_chunk_opts (hid_t plist_id, unsigned *opts)
 Retrieves the edge chunk option setting from a dataset creation property list. More...
 
herr_t H5Pget_dset_no_attrs_hint (hid_t dcpl_id, hbool_t *minimize)
 Retrieves the setting for whether or not to create minimized dataset object headers. More...
 
herr_t H5Pget_external (hid_t plist_id, unsigned idx, size_t name_size, char *name, off_t *offset, hsize_t *size)
 Returns information about an external file. More...
 
int H5Pget_external_count (hid_t plist_id)
 Returns the number of external files for a dataset. More...
 
herr_t H5Pget_fill_time (hid_t plist_id, H5D_fill_time_t *fill_time)
 Retrieves the time when fill values are written to a dataset. More...
 
herr_t H5Pget_fill_value (hid_t plist_id, hid_t type_id, void *value)
 Retrieves a dataset fill value. More...
 
H5D_layout_t H5Pget_layout (hid_t plist_id)
 Returns the layout of the raw data for a dataset. More...
 
herr_t H5Pget_virtual_count (hid_t dcpl_id, size_t *count)
 Gets the number of mappings for the virtual dataset. More...
 
ssize_t H5Pget_virtual_dsetname (hid_t dcpl_id, size_t index, char *name, size_t size)
 Gets the name of a source dataset used in the mapping. More...
 
ssize_t H5Pget_virtual_filename (hid_t dcpl_id, size_t index, char *name, size_t size)
 Gets the filename of a source dataset used in the mapping. More...
 
hid_t H5Pget_virtual_srcspace (hid_t dcpl_id, size_t index)
 Gets a dataspace identifier for the selection within the source dataset used in the mapping. More...
 
hid_t H5Pget_virtual_vspace (hid_t dcpl_id, size_t index)
 Gets a dataspace identifier for the selection within the virtual dataset used in the mapping. More...
 
herr_t H5Pset_alloc_time (hid_t plist_id, H5D_alloc_time_t alloc_time)
 Sets the timing for storage space allocation. More...
 
herr_t H5Pset_chunk (hid_t plist_id, int ndims, const hsize_t dim[])
 Sets the size of the chunks used to store a chunked layout dataset. More...
 
herr_t H5Pset_chunk_opts (hid_t plist_id, unsigned opts)
 Sets the edge chunk option in a dataset creation property list. More...
 
herr_t H5Pset_dset_no_attrs_hint (hid_t dcpl_id, hbool_t minimize)
 Sets the flag to create minimized dataset object headers. More...
 
herr_t H5Pset_external (hid_t plist_id, const char *name, off_t offset, hsize_t size)
 Adds an external file to the list of external files. More...
 
herr_t H5Pset_fill_time (hid_t plist_id, H5D_fill_time_t fill_time)
 Sets the time when fill values are written to a dataset. More...
 
herr_t H5Pset_fill_value (hid_t plist_id, hid_t type_id, const void *value)
 Sets the fill value for a dataset. More...
 
herr_t H5Pset_shuffle (hid_t plist_id)
 Sets up use of the shuffle filter. More...
 
herr_t H5Pset_layout (hid_t plist_id, H5D_layout_t layout)
 Sets the type of storage used to store the raw data for a dataset. More...
 
herr_t H5Pset_nbit (hid_t plist_id)
 Sets up the use of the N-Bit filter. More...
 
herr_t H5Pset_scaleoffset (hid_t plist_id, H5Z_SO_scale_type_t scale_type, int scale_factor)
 Sets up the use of the scale-offset filter. More...
 
herr_t H5Pset_szip (hid_t plist_id, unsigned options_mask, unsigned pixels_per_block)
 Sets up use of the SZIP compression filter. More...
 
herr_t H5Pset_virtual (hid_t dcpl_id, hid_t vspace_id, const char *src_file_name, const char *src_dset_name, hid_t src_space_id)
 Sets the mapping between virtual and source datasets. More...
 
herr_t H5Pget_append_flush (hid_t dapl_id, unsigned dims, hsize_t boundary[], H5D_append_cb_t *func, void **udata)
 Retrieves the values of the append property that is set up in the dataset access property list. More...
 
herr_t H5Pget_chunk_cache (hid_t dapl_id, size_t *rdcc_nslots, size_t *rdcc_nbytes, double *rdcc_w0)
 Retrieves the raw data chunk cache parameters. More...
 
ssize_t H5Pget_efile_prefix (hid_t dapl_id, char *prefix, size_t size)
 Retrieves the prefix for external raw data storage files as set in the dataset access property list. More...
 
ssize_t H5Pget_virtual_prefix (hid_t dapl_id, char *prefix, size_t size)
 Retrieves prefix applied to VDS source file paths. More...
 
herr_t H5Pget_virtual_printf_gap (hid_t dapl_id, hsize_t *gap_size)
 Returns the maximum number of missing source files and/or datasets with the printf-style names when getting the extent for an unlimited virtual dataset. More...
 
herr_t H5Pget_virtual_view (hid_t dapl_id, H5D_vds_view_t *view)
 Retrieves the view of a virtual dataset accessed with dapl_id. More...
 
herr_t H5Pset_append_flush (hid_t dapl_id, unsigned ndims, const hsize_t boundary[], H5D_append_cb_t func, void *udata)
 Sets two actions to perform when the size of a dataset’s dimension being appended reaches a specified boundary. More...
 
herr_t H5Pset_chunk_cache (hid_t dapl_id, size_t rdcc_nslots, size_t rdcc_nbytes, double rdcc_w0)
 Sets the raw data chunk cache parameters. More...
 
herr_t H5Pset_efile_prefix (hid_t dapl_id, const char *prefix)
 Sets the external dataset storage file prefix in the dataset access property list. More...
 
herr_t H5Pset_virtual_prefix (hid_t dapl_id, const char *prefix)
 Sets prefix to be applied to VDS source file paths. More...
 
herr_t H5Pset_virtual_printf_gap (hid_t dapl_id, hsize_t gap_size)
 Sets the maximum number of missing source files and/or datasets with the printf-style names when getting the extent of an unlimited virtual dataset. More...
 
herr_t H5Pset_virtual_view (hid_t dapl_id, H5D_vds_view_t view)
 Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements. More...
 
herr_t H5Pget_btree_ratios (hid_t plist_id, double *left, double *middle, double *right)
 Gets B-tree split ratios for a dataset transfer property list. More...
 
size_t H5Pget_buffer (hid_t plist_id, void **tconv, void **bkg)
 Reads buffer settings. More...
 
ssize_t H5Pget_data_transform (hid_t plist_id, char *expression, size_t size)
 Retrieves a data transform expression. More...
 
H5Z_EDC_t H5Pget_edc_check (hid_t plist_id)
 Determines whether error-detection is enabled for dataset reads. More...
 
herr_t H5Pget_hyper_vector_size (hid_t fapl_id, size_t *size)
 Retrieves number of I/O vectors to be read/written in hyperslab I/O. More...
 
int H5Pget_preserve (hid_t plist_id)
 Checks status of the dataset transfer property list (DEPRECATED) More...
 
herr_t H5Pget_type_conv_cb (hid_t dxpl_id, H5T_conv_except_func_t *op, void **operate_data)
 Gets user-defined datatype conversion callback function. More...
 
herr_t H5Pget_vlen_mem_manager (hid_t plist_id, H5MM_allocate_t *alloc_func, void **alloc_info, H5MM_free_t *free_func, void **free_info)
 Gets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim() More...
 
herr_t H5Pset_btree_ratios (hid_t plist_id, double left, double middle, double right)
 Sets B-tree split ratios for a dataset transfer property list. More...
 
herr_t H5Pset_buffer (hid_t plist_id, size_t size, void *tconv, void *bkg)
 Sets type conversion and background buffers. More...
 
herr_t H5Pset_data_transform (hid_t plist_id, const char *expression)
 Sets a data transform expression. More...
 
herr_t H5Pset_edc_check (hid_t plist_id, H5Z_EDC_t check)
 Sets the dataset transfer property list to enable or disable error detection when reading data. More...
 
herr_t H5Pset_filter_callback (hid_t plist_id, H5Z_filter_func_t func, void *op_data)
 Sets user-defined filter callback function. More...
 
herr_t H5Pset_hyper_vector_size (hid_t plist_id, size_t size)
 Sets number of I/O vectors to be read/written in hyperslab I/O. More...
 
herr_t H5Pset_preserve (hid_t plist_id, hbool_t status)
 Sets the dataset transfer property list status. More...
 
herr_t H5Pset_type_conv_cb (hid_t dxpl_id, H5T_conv_except_func_t op, void *operate_data)
 Sets user-defined datatype conversion callback function. More...
 
herr_t H5Pset_vlen_mem_manager (hid_t plist_id, H5MM_allocate_t alloc_func, void *alloc_info, H5MM_free_t free_func, void *free_info)
 Sets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim() More...
 
herr_t H5Pget_mpio_actual_chunk_opt_mode (hid_t plist_id, H5D_mpio_actual_chunk_opt_mode_t *actual_chunk_opt_mode)
 Retrieves the type of chunk optimization that HDF5 actually performed on the last parallel I/O call (not necessarily the type requested) More...
 
herr_t H5Pget_mpio_actual_io_mode (hid_t plist_id, H5D_mpio_actual_io_mode_t *actual_io_mode)
 Retrieves the type of I/O that HDF5 actually performed on the last parallel I/O call (not necessarily the type requested) More...
 
herr_t H5Pget_mpio_no_collective_cause (hid_t plist_id, uint32_t *local_no_collective_cause, uint32_t *global_no_collective_cause)
 Retrieves local and global causes that broke collective I/O on the last parallel I/O call. More...
 
herr_t H5Pget_create_intermediate_group (hid_t plist_id, unsigned *crt_intmd)
 Determines whether property is set to enable creating missing intermediate groups. More...
 
herr_t H5Pset_create_intermediate_group (hid_t plist_id, unsigned crt_intmd)
 Specifies in property list whether to create missing intermediate groups. More...
 
herr_t H5Pget_est_link_info (hid_t plist_id, unsigned *est_num_entries, unsigned *est_name_len)
 Returns the estimated link count and average link name length in a group. More...
 
herr_t H5Pget_link_creation_order (hid_t plist_id, unsigned *crt_order_flags)
 Queries whether link creation order is tracked and/or indexed in a group. More...
 
herr_t H5Pget_link_phase_change (hid_t plist_id, unsigned *max_compact, unsigned *min_dense)
 Queries the settings for conversion between compact and dense groups. More...
 
herr_t H5Pget_local_heap_size_hint (hid_t plist_id, size_t *size_hint)
 Retrieves the anticipated size of the local heap for original-style groups. More...
 
herr_t H5Pset_est_link_info (hid_t plist_id, unsigned est_num_entries, unsigned est_name_len)
 Sets estimated number of links and length of link names in a group. More...
 
herr_t H5Pset_link_creation_order (hid_t plist_id, unsigned crt_order_flags)
 Sets creation order tracking and indexing for links in a group. More...
 
herr_t H5Pset_link_phase_change (hid_t plist_id, unsigned max_compact, unsigned min_dense)
 Sets the parameters for conversion between compact and dense groups. More...
 
herr_t H5Pset_local_heap_size_hint (hid_t plist_id, size_t size_hint)
 Specifies the anticipated maximum size of a local heap. More...
 
herr_t H5Pget_char_encoding (hid_t plist_id, H5T_cset_t *encoding)
 Retrieves the character encoding used to create a link or attribute name. More...
 
herr_t H5Pset_char_encoding (hid_t plist_id, H5T_cset_t encoding)
 Sets the character encoding used to encode link and attribute names. More...
 
herr_t H5Pget_elink_acc_flags (hid_t lapl_id, unsigned *flags)
 Retrieves the external link traversal file access flag from the specified link access property list. More...
 
herr_t H5Pget_elink_cb (hid_t lapl_id, H5L_elink_traverse_t *func, void **op_data)
 Retrieves the external link traversal callback function from the specified link access property list. More...
 
hid_t H5Pget_elink_fapl (hid_t lapl_id)
 Retrieves the file access property list identifier associated with the link access property list. More...
 
ssize_t H5Pget_elink_prefix (hid_t plist_id, char *prefix, size_t size)
 Retrieves prefix applied to external link paths. More...
 
herr_t H5Pget_nlinks (hid_t plist_id, size_t *nlinks)
 Retrieves the maximum number of link traversals. More...
 
herr_t H5Pset_elink_acc_flags (hid_t lapl_id, unsigned flags)
 Sets the external link traversal file access flag in a link access property list. More...
 
herr_t H5Pset_elink_cb (hid_t lapl_id, H5L_elink_traverse_t func, void *op_data)
 Sets the external link traversal callback function in a link access property list. More...
 
herr_t H5Pset_elink_fapl (hid_t lapl_id, hid_t fapl_id)
 Sets a file access property list for use in accessing a file pointed to by an external link. More...
 
herr_t H5Pset_elink_prefix (hid_t plist_id, const char *prefix)
 Sets prefix to be applied to external link paths. More...
 
herr_t H5Pset_nlinks (hid_t plist_id, size_t nlinks)
 Sets maximum number of soft or user-defined link traversals. More...
 
herr_t H5Padd_merge_committed_dtype_path (hid_t plist_id, const char *path)
 Adds a path to the list of paths that will be searched in the destination file for a matching committed datatype. More...
 
herr_t H5Pfree_merge_committed_dtype_paths (hid_t plist_id)
 Clears the list of paths stored in the object copy property list. More...
 
herr_t H5Pget_copy_object (hid_t plist_id, unsigned *copy_options)
 Retrieves the properties to be used when an object is copied. More...
 
herr_t H5Pget_mcdt_search_cb (hid_t plist_id, H5O_mcdt_search_cb_t *func, void **op_data)
 Retrieves the callback function from the specified object copy property list. More...
 
herr_t H5Pset_copy_object (hid_t plist_id, unsigned copy_options)
 Sets properties to be used when an object is copied. More...
 
herr_t H5Pset_mcdt_search_cb (hid_t plist_id, H5O_mcdt_search_cb_t func, void *op_data)
 Sets the callback function that H5Ocopy() will invoke before searching the entire destination file for a matching committed datatype. More...
 
herr_t H5Pregister1 (hid_t cls_id, const char *name, size_t size, void *def_value, H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t prp_copy, H5P_prp_close_func_t prp_close)
 Registers a permanent property with a property list class. More...
 
herr_t H5Pinsert1 (hid_t plist_id, const char *name, size_t size, void *value, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_delete, H5P_prp_copy_func_t prp_copy, H5P_prp_close_func_t prp_close)
 Registers a temporary property with a property list. More...
 
herr_t H5Pencode1 (hid_t plist_id, void *buf, size_t *nalloc)
 Encodes the property values in a property list into a binary buffer. More...
 
H5Z_filter_t H5Pget_filter1 (hid_t plist_id, unsigned filter, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[])
 Returns information about a filter in a pipeline (DEPRECATED) More...
 
herr_t H5Pget_filter_by_id1 (hid_t plist_id, H5Z_filter_t id, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[])
 Returns information about the specified filter. More...
 
herr_t H5Pget_version (hid_t plist_id, unsigned *boot, unsigned *freelist, unsigned *stab, unsigned *shhdr)
 Retrieves the version information of various objects for a file creation property list(deprecated) More...
 
herr_t H5Pset_file_space (hid_t plist_id, H5F_file_space_type_t strategy, hsize_t threshold)
 Sets the file space handling strategy and the free-space section size threshold. More...
 
herr_t H5Pget_file_space (hid_t plist_id, H5F_file_space_type_t *strategy, hsize_t *threshold)
 Retrieves the file space handling strategy, and threshold value for a file creation property list. More...
 

Variables

hid_t H5P_CLS_ROOT_ID_g
 
hid_t H5P_CLS_OBJECT_CREATE_ID_g
 
hid_t H5P_CLS_FILE_CREATE_ID_g
 
hid_t H5P_CLS_FILE_ACCESS_ID_g
 
hid_t H5P_CLS_DATASET_CREATE_ID_g
 
hid_t H5P_CLS_DATASET_ACCESS_ID_g
 
hid_t H5P_CLS_DATASET_XFER_ID_g
 
hid_t H5P_CLS_FILE_MOUNT_ID_g
 
hid_t H5P_CLS_GROUP_CREATE_ID_g
 
hid_t H5P_CLS_GROUP_ACCESS_ID_g
 
hid_t H5P_CLS_DATATYPE_CREATE_ID_g
 
hid_t H5P_CLS_DATATYPE_ACCESS_ID_g
 
hid_t H5P_CLS_MAP_CREATE_ID_g
 
hid_t H5P_CLS_MAP_ACCESS_ID_g
 
hid_t H5P_CLS_STRING_CREATE_ID_g
 
hid_t H5P_CLS_ATTRIBUTE_CREATE_ID_g
 
hid_t H5P_CLS_ATTRIBUTE_ACCESS_ID_g
 
hid_t H5P_CLS_OBJECT_COPY_ID_g
 
hid_t H5P_CLS_LINK_CREATE_ID_g
 
hid_t H5P_CLS_LINK_ACCESS_ID_g
 
hid_t H5P_CLS_VOL_INITIALIZE_ID_g
 
hid_t H5P_CLS_REFERENCE_ACCESS_ID_g
 
hid_t H5P_LST_FILE_CREATE_ID_g
 
hid_t H5P_LST_FILE_ACCESS_ID_g
 
hid_t H5P_LST_DATASET_CREATE_ID_g
 
hid_t H5P_LST_DATASET_ACCESS_ID_g
 
hid_t H5P_LST_DATASET_XFER_ID_g
 
hid_t H5P_LST_FILE_MOUNT_ID_g
 
hid_t H5P_LST_GROUP_CREATE_ID_g
 
hid_t H5P_LST_GROUP_ACCESS_ID_g
 
hid_t H5P_LST_DATATYPE_CREATE_ID_g
 
hid_t H5P_LST_DATATYPE_ACCESS_ID_g
 
hid_t H5P_LST_MAP_CREATE_ID_g
 
hid_t H5P_LST_MAP_ACCESS_ID_g
 
hid_t H5P_LST_ATTRIBUTE_CREATE_ID_g
 
hid_t H5P_LST_ATTRIBUTE_ACCESS_ID_g
 
hid_t H5P_LST_OBJECT_COPY_ID_g
 
hid_t H5P_LST_LINK_CREATE_ID_g
 
hid_t H5P_LST_LINK_ACCESS_ID_g
 
hid_t H5P_LST_VOL_INITIALIZE_ID_g
 
hid_t H5P_LST_REFERENCE_ACCESS_ID_g
 

Macro Definition Documentation

◆ H5OPEN

#define H5OPEN   H5open(),

◆ H5P_ATTRIBUTE_ACCESS

#define H5P_ATTRIBUTE_ACCESS   (H5OPEN H5P_CLS_ATTRIBUTE_ACCESS_ID_g)

◆ H5P_ATTRIBUTE_ACCESS_DEFAULT

#define H5P_ATTRIBUTE_ACCESS_DEFAULT   (H5OPEN H5P_LST_ATTRIBUTE_ACCESS_ID_g)

◆ H5P_ATTRIBUTE_CREATE

#define H5P_ATTRIBUTE_CREATE   (H5OPEN H5P_CLS_ATTRIBUTE_CREATE_ID_g)

◆ H5P_ATTRIBUTE_CREATE_DEFAULT

#define H5P_ATTRIBUTE_CREATE_DEFAULT   (H5OPEN H5P_LST_ATTRIBUTE_CREATE_ID_g)

◆ H5P_CRT_ORDER_INDEXED

#define H5P_CRT_ORDER_INDEXED   0x0002

◆ H5P_CRT_ORDER_TRACKED

#define H5P_CRT_ORDER_TRACKED   0x0001

◆ H5P_DATASET_ACCESS

#define H5P_DATASET_ACCESS   (H5OPEN H5P_CLS_DATASET_ACCESS_ID_g)

◆ H5P_DATASET_ACCESS_DEFAULT

#define H5P_DATASET_ACCESS_DEFAULT   (H5OPEN H5P_LST_DATASET_ACCESS_ID_g)

◆ H5P_DATASET_CREATE

#define H5P_DATASET_CREATE   (H5OPEN H5P_CLS_DATASET_CREATE_ID_g)

◆ H5P_DATASET_CREATE_DEFAULT

#define H5P_DATASET_CREATE_DEFAULT   (H5OPEN H5P_LST_DATASET_CREATE_ID_g)

◆ H5P_DATASET_XFER

#define H5P_DATASET_XFER   (H5OPEN H5P_CLS_DATASET_XFER_ID_g)

◆ H5P_DATASET_XFER_DEFAULT

#define H5P_DATASET_XFER_DEFAULT   (H5OPEN H5P_LST_DATASET_XFER_ID_g)

◆ H5P_DATATYPE_ACCESS

#define H5P_DATATYPE_ACCESS   (H5OPEN H5P_CLS_DATATYPE_ACCESS_ID_g)

◆ H5P_DATATYPE_ACCESS_DEFAULT

#define H5P_DATATYPE_ACCESS_DEFAULT   (H5OPEN H5P_LST_DATATYPE_ACCESS_ID_g)

◆ H5P_DATATYPE_CREATE

#define H5P_DATATYPE_CREATE   (H5OPEN H5P_CLS_DATATYPE_CREATE_ID_g)

◆ H5P_DATATYPE_CREATE_DEFAULT

#define H5P_DATATYPE_CREATE_DEFAULT   (H5OPEN H5P_LST_DATATYPE_CREATE_ID_g)

◆ H5P_DEFAULT

#define H5P_DEFAULT   (hid_t)0

◆ H5P_FILE_ACCESS

#define H5P_FILE_ACCESS   (H5OPEN H5P_CLS_FILE_ACCESS_ID_g)

◆ H5P_FILE_ACCESS_DEFAULT

#define H5P_FILE_ACCESS_DEFAULT   (H5OPEN H5P_LST_FILE_ACCESS_ID_g)

◆ H5P_FILE_CREATE

#define H5P_FILE_CREATE   (H5OPEN H5P_CLS_FILE_CREATE_ID_g)

◆ H5P_FILE_CREATE_DEFAULT

#define H5P_FILE_CREATE_DEFAULT   (H5OPEN H5P_LST_FILE_CREATE_ID_g)

◆ H5P_FILE_MOUNT

#define H5P_FILE_MOUNT   (H5OPEN H5P_CLS_FILE_MOUNT_ID_g)

◆ H5P_FILE_MOUNT_DEFAULT

#define H5P_FILE_MOUNT_DEFAULT   (H5OPEN H5P_LST_FILE_MOUNT_ID_g)

◆ H5P_GROUP_ACCESS

#define H5P_GROUP_ACCESS   (H5OPEN H5P_CLS_GROUP_ACCESS_ID_g)

◆ H5P_GROUP_ACCESS_DEFAULT

#define H5P_GROUP_ACCESS_DEFAULT   (H5OPEN H5P_LST_GROUP_ACCESS_ID_g)

◆ H5P_GROUP_CREATE

#define H5P_GROUP_CREATE   (H5OPEN H5P_CLS_GROUP_CREATE_ID_g)

◆ H5P_GROUP_CREATE_DEFAULT

#define H5P_GROUP_CREATE_DEFAULT   (H5OPEN H5P_LST_GROUP_CREATE_ID_g)

◆ H5P_LINK_ACCESS

#define H5P_LINK_ACCESS   (H5OPEN H5P_CLS_LINK_ACCESS_ID_g)

◆ H5P_LINK_ACCESS_DEFAULT

#define H5P_LINK_ACCESS_DEFAULT   (H5OPEN H5P_LST_LINK_ACCESS_ID_g)

◆ H5P_LINK_CREATE

#define H5P_LINK_CREATE   (H5OPEN H5P_CLS_LINK_CREATE_ID_g)

◆ H5P_LINK_CREATE_DEFAULT

#define H5P_LINK_CREATE_DEFAULT   (H5OPEN H5P_LST_LINK_CREATE_ID_g)

◆ H5P_MAP_ACCESS

#define H5P_MAP_ACCESS   (H5OPEN H5P_CLS_MAP_ACCESS_ID_g)

◆ H5P_MAP_ACCESS_DEFAULT

#define H5P_MAP_ACCESS_DEFAULT   (H5OPEN H5P_LST_MAP_ACCESS_ID_g)

◆ H5P_MAP_CREATE

#define H5P_MAP_CREATE   (H5OPEN H5P_CLS_MAP_CREATE_ID_g)

◆ H5P_MAP_CREATE_DEFAULT

#define H5P_MAP_CREATE_DEFAULT   (H5OPEN H5P_LST_MAP_CREATE_ID_g)

◆ H5P_NO_CLASS

#define H5P_NO_CLASS   H5P_ROOT

◆ H5P_OBJECT_COPY

#define H5P_OBJECT_COPY   (H5OPEN H5P_CLS_OBJECT_COPY_ID_g)

◆ H5P_OBJECT_COPY_DEFAULT

#define H5P_OBJECT_COPY_DEFAULT   (H5OPEN H5P_LST_OBJECT_COPY_ID_g)

◆ H5P_OBJECT_CREATE

#define H5P_OBJECT_CREATE   (H5OPEN H5P_CLS_OBJECT_CREATE_ID_g)

◆ H5P_REFERENCE_ACCESS

#define H5P_REFERENCE_ACCESS   (H5OPEN H5P_CLS_REFERENCE_ACCESS_ID_g)

◆ H5P_REFERENCE_ACCESS_DEFAULT

#define H5P_REFERENCE_ACCESS_DEFAULT   (H5OPEN H5P_LST_REFERENCE_ACCESS_ID_g)

◆ H5P_ROOT

#define H5P_ROOT   (H5OPEN H5P_CLS_ROOT_ID_g)

◆ H5P_STRING_CREATE

#define H5P_STRING_CREATE   (H5OPEN H5P_CLS_STRING_CREATE_ID_g)

◆ H5P_VOL_INITIALIZE

#define H5P_VOL_INITIALIZE   (H5OPEN H5P_CLS_VOL_INITIALIZE_ID_g)

◆ H5P_VOL_INITIALIZE_DEFAULT

#define H5P_VOL_INITIALIZE_DEFAULT   (H5OPEN H5P_LST_VOL_INITIALIZE_ID_g)

Typedef Documentation

◆ H5P_cls_close_func_t

typedef herr_t(* H5P_cls_close_func_t) (hid_t prop_id, void *close_data)

◆ H5P_cls_copy_func_t

typedef herr_t(* H5P_cls_copy_func_t) (hid_t new_prop_id, hid_t old_prop_id, void *copy_data)

◆ H5P_cls_create_func_t

typedef herr_t(* H5P_cls_create_func_t) (hid_t prop_id, void *create_data)

◆ H5P_iterate_t

typedef herr_t(* H5P_iterate_t) (hid_t id, const char *name, void *iter_data)

◆ H5P_prp_cb1_t

typedef herr_t(* H5P_prp_cb1_t) (const char *name, size_t size, void *value)

Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()

Parameters
[in]nameThe name of the property
[in]sizeThe size of the property in bytes
[in,out]valueThe value for the property
Returns
Returns a non-negative value if successful; otherwise returns a negative value.

The H5P_prp_cb1_t() describes the parameters used by the property create,copy and close callback functions.

◆ H5P_prp_cb2_t

typedef herr_t(* H5P_prp_cb2_t) (hid_t prop_id, const char *name, size_t size, void *value)

Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()

Parameters
[in]prop_idProperty list identifier
[in]nameThe name of the property
[in]sizeThe size of the property in bytes
[in]valueThe value for the property
Returns
Returns a non-negative value if successful; otherwise returns a negative value.

The H5P_prp_cb2_t() describes the parameters used by the property set ,copy and delete callback functions.

◆ H5P_prp_close_func_t

◆ H5P_prp_compare_func_t

typedef int(* H5P_prp_compare_func_t) (const void *value1, const void *value2, size_t size)

◆ H5P_prp_copy_func_t

◆ H5P_prp_create_func_t

◆ H5P_prp_decode_func_t

typedef herr_t(* H5P_prp_decode_func_t) (const void **buf, void *value)

◆ H5P_prp_delete_func_t

◆ H5P_prp_encode_func_t

typedef herr_t(* H5P_prp_encode_func_t) (const void *value, void **buf, size_t *size)

◆ H5P_prp_get_func_t

◆ H5P_prp_set_func_t

Enumeration Type Documentation

◆ H5D_mpio_actual_chunk_opt_mode_t

Actual IO mode property

The default value, H5D_MPIO_NO_CHUNK_OPTIMIZATION, is used for all I/O operations that do not use chunk optimizations, including non-collective I/O and contiguous collective I/O.

Enumerator
H5D_MPIO_NO_CHUNK_OPTIMIZATION 

No chunk optimization was performed. Either no collective I/O was attempted or the dataset wasn't chunked.

H5D_MPIO_LINK_CHUNK 

Collective I/O is performed on all chunks simultaneously.

H5D_MPIO_MULTI_CHUNK 

Each chunk was individually assigned collective or independent I/O based on what fraction of processes access the chunk. If the fraction is greater than the multi chunk ratio threshold, collective I/O is performed on that chunk. The multi chunk ratio threshold can be set using H5Pset_dxpl_mpio_chunk_opt_ratio(). The default value is 60%.

◆ H5D_mpio_actual_io_mode_t

The following values are conveniently defined as a bit field so that we can switch from the default to independent or collective and then to mixed without having to check the original value.

Enumerator
H5D_MPIO_NO_COLLECTIVE 

No collective I/O was performed. Collective I/O was not requested or collective I/O isn't possible on this dataset

H5D_MPIO_CHUNK_INDEPENDENT 

HDF5 performed one the chunk collective optimization schemes and each chunk was accessed independently

H5D_MPIO_CHUNK_COLLECTIVE 

HDF5 performed one the chunk collective optimization schemes and each chunk was accessed collectively

H5D_MPIO_CHUNK_MIXED 

HDF5 performed one the chunk collective optimization schemes and some chunks were accessed independently, some collectively.

H5D_MPIO_CONTIGUOUS_COLLECTIVE 

Collective I/O was performed on a contiguous dataset

◆ H5D_mpio_no_collective_cause_t

Broken collective IO property

Enumerator
H5D_MPIO_COLLECTIVE 

Collective I/O was performed successfully

H5D_MPIO_SET_INDEPENDENT 

Collective I/O was not performed because independent I/O was requested

H5D_MPIO_DATATYPE_CONVERSION 

Collective I/O was not performed because datatype conversions were required

H5D_MPIO_DATA_TRANSFORMS 

Collective I/O was not performed because data transforms needed to be applied

H5D_MPIO_MPI_OPT_TYPES_ENV_VAR_DISABLED 
Todo:
FIXME!
H5D_MPIO_NOT_SIMPLE_OR_SCALAR_DATASPACES 

Collective I/O was not performed because one of the dataspaces was neither simple nor scalar

H5D_MPIO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET 

Collective I/O was not performed because the dataset was neither contiguous nor chunked

H5D_MPIO_PARALLEL_FILTERED_WRITES_DISABLED 
Todo:
FIXME!
H5D_MPIO_ERROR_WHILE_CHECKING_COLLECTIVE_POSSIBLE 
Todo:
FIXME!
H5D_MPIO_NO_COLLECTIVE_MAX_CAUSE 

Sentinel

Function Documentation

◆ H5Pget_mpi_params()

herr_t H5Pget_mpi_params ( hid_t  fapl_id,
MPI_Comm *  comm,
MPI_Info *  info 
)
Todo:
Add missing documentation

◆ H5Pset_mpi_params()

herr_t H5Pset_mpi_params ( hid_t  fapl_id,
MPI_Comm  comm,
MPI_Info  info 
)
Todo:
Add missing documentation

Variable Documentation

◆ H5P_CLS_ATTRIBUTE_ACCESS_ID_g

hid_t H5P_CLS_ATTRIBUTE_ACCESS_ID_g

◆ H5P_CLS_ATTRIBUTE_CREATE_ID_g

hid_t H5P_CLS_ATTRIBUTE_CREATE_ID_g

◆ H5P_CLS_DATASET_ACCESS_ID_g

hid_t H5P_CLS_DATASET_ACCESS_ID_g

◆ H5P_CLS_DATASET_CREATE_ID_g

hid_t H5P_CLS_DATASET_CREATE_ID_g

◆ H5P_CLS_DATASET_XFER_ID_g

hid_t H5P_CLS_DATASET_XFER_ID_g

◆ H5P_CLS_DATATYPE_ACCESS_ID_g

hid_t H5P_CLS_DATATYPE_ACCESS_ID_g

◆ H5P_CLS_DATATYPE_CREATE_ID_g

hid_t H5P_CLS_DATATYPE_CREATE_ID_g

◆ H5P_CLS_FILE_ACCESS_ID_g

hid_t H5P_CLS_FILE_ACCESS_ID_g

◆ H5P_CLS_FILE_CREATE_ID_g

hid_t H5P_CLS_FILE_CREATE_ID_g

◆ H5P_CLS_FILE_MOUNT_ID_g

hid_t H5P_CLS_FILE_MOUNT_ID_g

◆ H5P_CLS_GROUP_ACCESS_ID_g

hid_t H5P_CLS_GROUP_ACCESS_ID_g

◆ H5P_CLS_GROUP_CREATE_ID_g

hid_t H5P_CLS_GROUP_CREATE_ID_g

◆ H5P_CLS_LINK_ACCESS_ID_g

hid_t H5P_CLS_LINK_ACCESS_ID_g

◆ H5P_CLS_LINK_CREATE_ID_g

hid_t H5P_CLS_LINK_CREATE_ID_g

◆ H5P_CLS_MAP_ACCESS_ID_g

hid_t H5P_CLS_MAP_ACCESS_ID_g

◆ H5P_CLS_MAP_CREATE_ID_g

hid_t H5P_CLS_MAP_CREATE_ID_g

◆ H5P_CLS_OBJECT_COPY_ID_g

hid_t H5P_CLS_OBJECT_COPY_ID_g

◆ H5P_CLS_OBJECT_CREATE_ID_g

hid_t H5P_CLS_OBJECT_CREATE_ID_g

◆ H5P_CLS_REFERENCE_ACCESS_ID_g

hid_t H5P_CLS_REFERENCE_ACCESS_ID_g

◆ H5P_CLS_ROOT_ID_g

hid_t H5P_CLS_ROOT_ID_g

◆ H5P_CLS_STRING_CREATE_ID_g

hid_t H5P_CLS_STRING_CREATE_ID_g

◆ H5P_CLS_VOL_INITIALIZE_ID_g

hid_t H5P_CLS_VOL_INITIALIZE_ID_g

◆ H5P_LST_ATTRIBUTE_ACCESS_ID_g

hid_t H5P_LST_ATTRIBUTE_ACCESS_ID_g

◆ H5P_LST_ATTRIBUTE_CREATE_ID_g

hid_t H5P_LST_ATTRIBUTE_CREATE_ID_g

◆ H5P_LST_DATASET_ACCESS_ID_g

hid_t H5P_LST_DATASET_ACCESS_ID_g

◆ H5P_LST_DATASET_CREATE_ID_g

hid_t H5P_LST_DATASET_CREATE_ID_g

◆ H5P_LST_DATASET_XFER_ID_g

hid_t H5P_LST_DATASET_XFER_ID_g

◆ H5P_LST_DATATYPE_ACCESS_ID_g

hid_t H5P_LST_DATATYPE_ACCESS_ID_g

◆ H5P_LST_DATATYPE_CREATE_ID_g

hid_t H5P_LST_DATATYPE_CREATE_ID_g

◆ H5P_LST_FILE_ACCESS_ID_g

hid_t H5P_LST_FILE_ACCESS_ID_g

◆ H5P_LST_FILE_CREATE_ID_g

hid_t H5P_LST_FILE_CREATE_ID_g

◆ H5P_LST_FILE_MOUNT_ID_g

hid_t H5P_LST_FILE_MOUNT_ID_g

◆ H5P_LST_GROUP_ACCESS_ID_g

hid_t H5P_LST_GROUP_ACCESS_ID_g

◆ H5P_LST_GROUP_CREATE_ID_g

hid_t H5P_LST_GROUP_CREATE_ID_g

◆ H5P_LST_LINK_ACCESS_ID_g

hid_t H5P_LST_LINK_ACCESS_ID_g

◆ H5P_LST_LINK_CREATE_ID_g

hid_t H5P_LST_LINK_CREATE_ID_g

◆ H5P_LST_MAP_ACCESS_ID_g

hid_t H5P_LST_MAP_ACCESS_ID_g

◆ H5P_LST_MAP_CREATE_ID_g

hid_t H5P_LST_MAP_CREATE_ID_g

◆ H5P_LST_OBJECT_COPY_ID_g

hid_t H5P_LST_OBJECT_COPY_ID_g

◆ H5P_LST_REFERENCE_ACCESS_ID_g

hid_t H5P_LST_REFERENCE_ACCESS_ID_g

◆ H5P_LST_VOL_INITIALIZE_ID_g

hid_t H5P_LST_VOL_INITIALIZE_ID_g