Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5 1.14.5
API Reference
Loading...
Searching...
No Matches
Fortran Property List (H5P) Interface

Detailed Description

See also
Property Lists (H5P), C-API
Properties and Property Lists in HDF5, User Guide

Modules

module  h5p
 This module contains Fortran interfaces for H5P functions.
 

Data Types

type  h5fd_subfiling_params_t
 H5FD_subfiling_params_t derived type used in the subfiling VFD. More...
 
type  h5fd_subfiling_config_t
 H5FD_subfiling_config_t derived type used in the subfiling VFD. More...
 
type  h5fd_ioc_config_t
 H5FD_ioc_config_t derived type used in the IOC VFD (SUBFILING). More...
 

Functions/Subroutines

subroutine h5pcreate_f (class, prp_id, hdferr)
 Creates a new property as an instance of a property list class.
 
subroutine h5pset_preserve_f (prp_id, flag, hdferr)
 Sets the dataset transfer property list status to TRUE or FALSE for initializing compound datatype members during write/read operations.
 
subroutine h5pget_preserve_f (prp_id, flag, hdferr)
 Checks status of the dataset transfer property list.
 
subroutine h5pget_class_f (prp_id, classtype, hdferr)
 Returns the property list class for a property list.
 
subroutine h5pcopy_f (prp_id, new_prp_id, hdferr)
 Copies an existing property list to create a new property list.
 
subroutine h5pclose_f (prp_id, hdferr)
 Terminates access to a property list.
 
subroutine h5pset_chunk_f (prp_id, ndims, dims, hdferr)
 Sets the size of the chunks used to store a chunked layout dataset.
 
subroutine h5pget_chunk_f (prp_id, ndims, dims, hdferr)
 Retrieves the size of chunks for the raw data of a chunked layout dataset.
 
subroutine h5pset_deflate_f (prp_id, level, hdferr)
 Sets compression method and compression level.
 
subroutine h5pget_version_f (prp_id, boot, freelist, stab, shhdr, hdferr)
 Retrieves the version information of various objects for a file creation property list.
 
subroutine h5pset_userblock_f (prp_id, size, hdferr)
 Sets user block size.
 
subroutine h5pget_userblock_f (prp_id, block_size, hdferr)
 Gets user block size.
 
subroutine h5pset_selection_io_f (plist_id, selection_io_mode, hdferr)
 Sets the selection I/O mode.
 
subroutine h5pget_selection_io_f (plist_id, selection_io_mode, hdferr)
 Retrieves the selection I/O mode.
 
subroutine h5pset_modify_write_buf_f (plist_id, modify_write_buf, hdferr)
 Allows the library to modify the contents of the write buffer.
 
subroutine h5pget_modify_write_buf_f (plist_id, modify_write_buf, hdferr)
 Retrieves the "modify write buffer" property.
 
subroutine h5pset_sizes_f (prp_id, sizeof_addr, sizeof_size, hdferr)
 Sets the byte size of the offsets and lengths used to address objects in an HDF5 file.
 
subroutine h5pget_sizes_f (prp_id, sizeof_addr, sizeof_size, hdferr)
 Retrieves the size of the offsets and lengths used in an HDF5 file.
 
subroutine h5pset_sym_k_f (prp_id, ik, lk, hdferr)
 Sets the size of parameters used to control the symbol table nodes.
 
subroutine h5pget_sym_k_f (prp_id, ik, lk, hdferr)
 Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size.
 
subroutine h5pset_istore_k_f (prp_id, ik, hdferr)
 Sets the size of the parameter used to control the B-trees for indexing chunked datasets.
 
subroutine h5pget_istore_k_f (prp_id, ik, hdferr)
 Queries the 1/2 rank of an indexed storage B-tree.
 
subroutine h5pget_driver_f (prp_id, driver, hdferr)
 Returns low-lever driver identifier.
 
subroutine h5pset_fapl_stdio_f (prp_id, hdferr)
 Sets the standard I/O driver.
 
subroutine h5pset_fapl_sec2_f (prp_id, hdferr)
 Sets the sec2 driver.
 
subroutine h5pset_alignment_f (prp_id, threshold, alignment, hdferr)
 Sets alignment properties of a file access property list.
 
subroutine h5pget_alignment_f (prp_id, threshold, alignment, hdferr)
 Retrieves the current settings for alignment properties from a file access property list.
 
subroutine h5pset_fapl_core_f (prp_id, increment, backing_store, hdferr)
 Modifies the file access property list to use the H5FD_CORE driver.
 
subroutine h5pget_fapl_core_f (prp_id, increment, backing_store, hdferr)
 Queries core file driver properties.
 
subroutine h5pset_fapl_family_f (prp_id, memb_size, memb_plist, hdferr)
 Sets the file access property list to use the family driver.
 
subroutine h5pget_fapl_family_f (prp_id, memb_size, memb_plist, hdferr)
 Returns file access property list information.
 
subroutine h5pset_cache_f (prp_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes, rdcc_w0, hdferr)
 Sets the meta data cache and raw data chunk cache parameters.
 
subroutine h5pget_cache_f (prp_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes, rdcc_w0, hdferr)
 Queries the meta data cache and raw data chunk cache parameters.
 
subroutine h5pset_fapl_split_f (prp_id, meta_ext, meta_plist, raw_ext, raw_plist, hdferr)
 Emulates the old split file driver.
 
subroutine h5pset_gc_references_f (prp_id, gc_reference, hdferr)
 Sets garbage collecting references flag.
 
subroutine h5pget_gc_references_f (prp_id, gc_reference, hdferr)
 Returns garbage collecting references setting.
 
subroutine h5pset_layout_f (prp_id, layout, hdferr)
 Sets the type of storage used store the raw data for a dataset.
 
subroutine h5pget_layout_f (prp_id, layout, hdferr)
 Returns the layout of the raw data for a dataset.
 
subroutine h5pset_filter_f (prp_id, filter, flags, cd_nelmts, cd_values, hdferr)
 Adds a filter to the filter pipeline.
 
subroutine h5pget_nfilters_f (prp_id, nfilters, hdferr)
 Returns the number of filters in the pipeline.
 
subroutine h5pget_filter_f (prp_id, filter_number, flags, cd_nelmts, cd_values, namelen, name, filter_id, hdferr)
 Returns information about a filter in a pipeline.
 
subroutine h5pset_external_f (prp_id, name, offset, bytes, hdferr)
 Adds an external file to the list of external files.
 
subroutine h5pget_external_count_f (prp_id, count, hdferr)
 Returns the number of external files for a dataset.
 
subroutine h5pget_external_f (prp_id, idx, name_size, name, offset, bytes, hdferr)
 Returns information about an external file.
 
subroutine h5pset_btree_ratios_f (prp_id, left, middle, right, hdferr)
 Sets B-tree split ratios for a dataset transfer property list.
 
subroutine h5pget_btree_ratios_f (prp_id, left, middle, right, hdferr)
 Gets B-tree split ratios for a dataset transfer property list.
 
subroutine h5pget_fclose_degree_f (fapl_id, degree, hdferr)
 Returns the degree for the file close behavior.
 
subroutine h5pset_fclose_degree_f (fapl_id, degree, hdferr)
 Sets the degree for the file close behavior.
 
subroutine h5pequal_f (plist1_id, plist2_id, flag, hdferr)
 Checks if two property lists are equal.
 
subroutine h5pset_buffer_f (plist_id, size, hdferr)
 Sets sixe for conversion buffer.
 
subroutine h5pget_buffer_f (plist_id, size, hdferr)
 Gets size for conversion buffer.
 
subroutine h5pfill_value_defined_f (plist_id, flag, hdferr)
 Check if fill value is defined.
 
subroutine h5pset_alloc_time_f (plist_id, flag, hdferr)
 Set space allocation time for dataset during creation.
 
subroutine h5pget_alloc_time_f (plist_id, flag, hdferr)
 Get space allocation time for dataset during creation.
 
subroutine h5pset_fill_time_f (plist_id, flag, hdferr)
 Set fill value writing time for dataset.
 
subroutine h5pget_fill_time_f (plist_id, flag, hdferr)
 Get fill value writing time for dataset.
 
subroutine h5pset_meta_block_size_f (plist_id, size, hdferr)
 Sets the minimum size of metadata block allocations.
 
subroutine h5pget_meta_block_size_f (plist_id, size, hdferr)
 Gets the minimum size of metadata block allocations.
 
subroutine h5pset_sieve_buf_size_f (plist_id, size, hdferr)
 Sets the maximum size of the data sieve buffer.
 
subroutine h5pget_sieve_buf_size_f (plist_id, size, hdferr)
 Gets the maximum size of the data sieve buffer.
 
subroutine h5pset_small_data_block_size_f (plist_id, size, hdferr)
 Sets the minimum size of "small" raw data block.
 
subroutine h5pget_small_data_block_size_f (plist_id, size, hdferr)
 Gets the minimum size of "small" raw data block.
 
subroutine h5pset_hyper_vector_size_f (plist_id, size, hdferr)
 Set the number of "I/O" vectors (vector size)
 
subroutine h5pget_hyper_vector_size_f (plist_id, size, hdferr)
 Get the number of "I/O" vectors (vector size)
 
subroutine h5pexist_f (prp_id, name, flag, hdferr)
 Queries whether a property name exists in a property list or class.
 
subroutine h5pget_size_f (prp_id, name, size, hdferr)
 Queries the size of a property value in bytes.
 
subroutine h5pget_nprops_f (prp_id, nprops, hdferr)
 Queries number of properties in property list or class.
 
subroutine h5pget_class_name_f (prp_id, name, size, hdferr)
 Queries the name of a class.
 
subroutine h5pget_class_parent_f (prp_id, parent_id, hdferr)
 Retrieves the parent class of a generic property class.
 
subroutine h5pisa_class_f (plist, pclass, flag, hdferr)
 Determines whether a property list is a member of a class.
 
subroutine h5pcopy_prop_f (dst_id, src_id, name, hdferr)
 Copies a property from one list or class to another.
 
subroutine h5premove_f (plid, name, hdferr)
 Removes a property from a property list.
 
subroutine h5punregister_f (class, name, hdferr)
 Removes a property from a property list class.
 
subroutine h5pclose_class_f (class, hdferr)
 Closes an existing property list class.
 
subroutine h5pset_shuffle_f (prp_id, hdferr)
 Sets shuffling filter.
 
subroutine h5pset_edc_check_f (prp_id, flag, hdferr)
 Enables/disables error detecting.
 
subroutine h5pget_edc_check_f (prp_id, flag, hdferr)
 Determines whether error-detection is enabled for dataset reads.
 
subroutine h5pset_fletcher32_f (prp_id, hdferr)
 Sets Fletcher32 checksum of EDC for a dataset creation property list.
 
subroutine h5pset_family_offset_f (prp_id, offset, hdferr)
 Sets offset for family file driver.
 
subroutine h5pset_szip_f (prp_id, options_mask, pixels_per_block, hdferr)
 Sets up use of szip compression.
 
subroutine h5pall_filters_avail_f (prp_id, flag, hdferr)
 Checks if all filters set in the dataset creation property list are available.
 
subroutine h5pget_filter_by_id_f (prp_id, filter_id, flags, cd_nelmts, cd_values, namelen, name, hdferr)
 Returns information about a filter in a pipeline.
 
subroutine h5pmodify_filter_f (prp_id, filter, flags, cd_nelmts, cd_values, hdferr)
 Adds a filter to the filter pipeline.
 
subroutine h5premove_filter_f (prp_id, filter, hdferr)
 Delete one or more filters from the filter pipeline.
 
subroutine h5pget_attr_phase_change_f (ocpl_id, max_compact, min_dense, hdferr)
 Retrieves attribute storage phase change thresholds.
 
subroutine h5pset_attr_creation_order_f (ocpl_id, crt_order_flags, hdferr)
 Sets tracking and indexing of attribute creation order.
 
subroutine h5pset_shared_mesg_nindexes_f (plist_id, nindexes, hdferr)
 Sets number of shared object header message indexes.
 
subroutine h5pset_shared_mesg_index_f (fcpl_id, index_num, mesg_type_flags, min_mesg_size, hdferr)
 Configures the specified shared object header message index.
 
subroutine h5pget_attr_creation_order_f (ocpl_id, crt_order_flags, hdferr)
 Retrieves tracking and indexing settings for attribute creation order.
 
subroutine h5pget_libver_bounds_f (fapl_id, low, high, hdferr)
 Retrieves the lower and upper bounds on the HDF5 library release versions that indirectly determine the object format versions used when creating objects in the file.
 
subroutine h5pset_libver_bounds_f (fapl_id, low, high, hdferr)
 Sets bounds on library versions, and indirectly format versions, to be used when creating objects.
 
subroutine h5pset_link_creation_order_f (gcpl_id, crt_order_flags, hdferr)
 Sets creation order tracking and indexing for links in a group.
 
subroutine h5pget_link_phase_change_f (gcpl_id, max_compact, min_dense, hdferr)
 Queries the settings for conversion between compact and dense groups.
 
subroutine h5pget_obj_track_times_f (plist_id, flag, hdferr)
 Returns whether times are tracked for an object.
 
subroutine h5pset_obj_track_times_f (plist_id, flag, hdferr)
 Set whether the birth, access, modification & change times for an object are stored.
 
subroutine h5pset_create_inter_group_f (lcpl_id, crt_intermed_group, hdferr)
 Specifies in property list whether to create missing intermediate groups.
 
subroutine h5pget_link_creation_order_f (gcpl_id, crt_order_flags, hdferr)
 Queries whether link creation order is tracked and/or indexed in a group.
 
subroutine h5pset_char_encoding_f (plist_id, encoding, hdferr)
 Sets the character encoding used to encode a string.
 
subroutine h5pget_char_encoding_f (plist_id, encoding, hdferr)
 Retrieves the character encoding used to create a string.
 
subroutine h5pset_copy_object_f (ocp_plist_id, copy_options, hdferr)
 Sets properties to be used when an object is copied.
 
subroutine h5pget_copy_object_f (ocp_plist_id, copy_options, hdferr)
 Retrieves the properties to be used when an object is copied.
 
subroutine h5pget_data_transform_f (plist_id, expression, hdferr, size)
 Retrieves a data transform expression.
 
subroutine h5pset_data_transform_f (plist_id, expression, hdferr)
 Sets a data transform expression.
 
subroutine h5pget_local_heap_size_hint_f (gcpl_id, size_hint, hdferr)
 Queries the local heap size hint for original-style groups.
 
subroutine h5pget_est_link_info_f (gcpl_id, est_num_entries, est_name_len, hdferr)
 Queries data required to estimate required local heap or object header size.
 
subroutine h5pset_local_heap_size_hint_f (gcpl_id, size_hint, hdferr)
 Sets the local heap size hint for original-style groups.
 
subroutine h5pset_est_link_info_f (gcpl_id, est_num_entries, est_name_len, hdferr)
 Sets estimated number of links and length of link names in a group.
 
subroutine h5pset_link_phase_change_f (gcpl_id, max_compact, min_dense, hdferr)
 Sets the parameters for conversion between compact and dense groups.
 
subroutine h5pset_fapl_direct_f (fapl_id, alignment, block_size, cbuf_size, hdferr)
 Sets up use of the direct I/O driver.
 
subroutine h5pget_fapl_direct_f (fapl_id, alignment, block_size, cbuf_size, hdferr)
 Gets up use of the direct I/O driver.
 
subroutine h5pset_attr_phase_change_f (ocpl_id, max_compact, min_dense, hdferr)
 Sets attribute storage phase change thresholds.
 
subroutine h5pset_nbit_f (plist_id, hdferr)
 Sets up the use of the N-Bit filter.
 
subroutine h5pset_scaleoffset_f (plist_id, scale_type, scale_factor, hdferr)
 Sets up the use of the scale-offset filter.
 
subroutine h5pset_nlinks_f (lapl_id, nlinks, hdferr)
 Sets maximum number of soft or user-defined link traversals.
 
subroutine h5pget_nlinks_f (lapl_id, nlinks, hdferr)
 Gets maximum number of soft or user-defined link traversals.
 
subroutine h5pget_create_inter_group_f (lcpl_id, crt_intermed_group, hdferr)
 Determines whether property is set to enable creating missing intermediate groups.
 
subroutine h5pset_chunk_cache_f (dapl_id, rdcc_nslots, rdcc_nbytes, rdcc_w0, hdferr)
 Set the number of objects in the meta data cache and the maximum number of chunks and bytes in the raw data chunk cache. Once set, these values will override the values in the file access property list. Each of these values can be individually unset (or not set at all) by passing the macros: H5D_CHUNK_CACHE_NSLOTS_DFLT_F, H5D_CHUNK_CACHE_NBYTES_DFLT_F, and/or H5D_CHUNK_CACHE_W0_DFLT_F as appropriate.
 
subroutine h5pget_chunk_cache_f (dapl_id, rdcc_nslots, rdcc_nbytes, rdcc_w0, hdferr)
 Retrieves the raw data chunk cache parameters.
 
subroutine h5pset_fill_value_f (prp_id, type_id, fillvalue, hdferr)
 Sets fill value for a dataset creation property list.
 
subroutine h5pget_fill_value_f (prp_id, type_id, fillvalue, hdferr)
 Gets fill value for a dataset creation property list.
 
subroutine h5pset_fill_value_f (prp_id, type_id, fillvalue, hdferr)
 Sets fill value for a dataset creation property list.
 
subroutine h5pget_fill_value_f (prp_id, type_id, fillvalue, hdferr)
 Gets fill value for a dataset creation property list.
 
subroutine h5pset_f (prp_id, name, value, hdferr)
 Sets a property list value.
 
subroutine h5pset_f (prp_id, name, value, hdferr)
 Sets a property list value.
 
subroutine h5pget_f (prp_id, name, value, hdferr)
 Queries the value of a property.
 
subroutine h5pget_f (prp_id, name, value, hdferr)
 Queries the value of a property.
 
subroutine h5pregister_f (class, name, size, value, hdferr)
 Registers a permanent property with a property list class.
 
subroutine h5pregister_f (class, name, size, value, hdferr)
 Registers a permanent property with a property list class.
 
subroutine h5pinsert_f (plist, name, size, value, hdferr)
 Registers a temporary property with a property list class.
 
subroutine h5pinsert_f (plist, name, size, value, hdferr)
 Registers a temporary property with a property list class.
 
subroutine h5pcreate_class_f (parent, name, class, hdferr, create, create_data, copy, copy_data, close, close_data)
 Create a new property list class.
 
subroutine h5pset_file_image_f (fapl_id, buf_ptr, buf_len, hdferr)
 Sets an initial file image in a memory buffer.
 
subroutine h5pget_file_image_f (fapl_id, buf_ptr, buf_len_ptr, hdferr)
 Retrieves a copy of the file image designated as the initial content and structure of a file.
 
subroutine h5pset_fapl_mpio_f (prp_id, comm, info, hdferr)
 Stores MPI IO communicator information to the file access property list.
 
subroutine h5pset_fapl_mpio_f (prp_id, comm, info, hdferr)
 Stores MPI IO communicator information to the file access property list.
 
subroutine h5pget_fapl_mpio_f (prp_id, comm, info, hdferr)
 Returns MPI communicator information.
 
subroutine h5pget_fapl_mpio_f (prp_id, comm, info, hdferr)
 Returns MPI communicator information.
 
subroutine h5pset_fapl_subfiling_f (prp_id, hdferr, vfd_config)
 Modifies the specified File Access Property List to use the H5FD_SUBFILING driver.
 
subroutine h5pget_fapl_subfiling_f (prp_id, vfd_config, hdferr)
 Queries a File Access Property List for H5FD_SUBFILING file driver properties.
 
subroutine h5pset_fapl_ioc_f (prp_id, hdferr, vfd_config)
 Modifies the specified File Access Property List to use the H5FD_IOC driver.
 
subroutine h5pget_fapl_ioc_f (prp_id, vfd_config, hdferr)
 Queries a File Access Property List for H5FD_IOC file driver properties.
 
subroutine h5pget_mpio_no_collective_cause_f (plist_id, local_no_collective_cause, global_no_collective_cause, hdferr)
 Retrieves local and global causes that broke collective I/O on the last parallel I/O call.
 
subroutine h5pset_mpi_params_f (prp_id, comm, info, hdferr)
 Set the MPI communicator and information.
 
subroutine h5pset_mpi_params_f (prp_id, comm, info, hdferr)
 Set the MPI communicator and information.
 
subroutine h5pget_mpi_params_f (prp_id, comm, info, hdferr)
 Get the MPI communicator and info.
 
subroutine h5pget_mpi_params_f (prp_id, comm, info, hdferr)
 Get the MPI communicator and information.
 
subroutine h5pset_dxpl_mpio_f (prp_id, data_xfer_mode, hdferr)
 Sets data transfer mode.
 
subroutine h5pget_dxpl_mpio_f (prp_id, data_xfer_mode, hdferr)
 Returns the data transfer mode.
 
subroutine h5pget_mpio_actual_io_mode_f (dxpl_id, actual_io_mode, hdferr)
 Retrieves the type of I/O that HDF5 actually performed on the last parallel I/O call. This is not necessarily the type of I/O requested.
 
subroutine h5pset_all_coll_metadata_ops_f (plist_id, is_collective, hdferr)
 Sets requirement whether HDF5 metadata read operations using the access property list are required to be collective or independent. If collective requirement is selected, the HDF5 library will optimize the metadata reads improving performance. The default setting is independent (false).
 
subroutine h5pget_all_coll_metadata_ops_f (plist_id, is_collective, hdferr)
 Retrieves metadata read mode from the access property list.
 
subroutine h5pset_coll_metadata_write_f (plist_id, is_collective, hdferr)
 Sets metadata writes to collective or independent. Default setting is independent (false).
 
subroutine h5pget_coll_metadata_write_f (plist_id, is_collective, hdferr)
 Retrieves metadata write mode from the file access property list.
 
subroutine h5pset_virtual_view_f (dapl_id, view, hdferr)
 Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements.
 
subroutine h5pget_virtual_view_f (dapl_id, view, hdferr)
 Retrieves the view of a virtual dataset accessed with dapl_id.
 
subroutine h5pset_virtual_printf_gap_f (dapl_id, gap_size, hdferr)
 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.
 
subroutine h5pget_virtual_printf_gap_f (dapl_id, gap_size, hdferr)
 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.
 
subroutine h5pset_virtual_f (dcpl_id, vspace_id, src_file_name, src_dset_name, src_space_id, hdferr)
 Sets the mapping between virtual and source datasets.
 
subroutine h5pget_virtual_count_f (dcpl_id, count, hdferr)
 Gets the number of mappings for the virtual dataset.
 
subroutine h5pget_virtual_vspace_f (dcpl_id, index, ds_id, hdferr)
 Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.
 
subroutine h5pget_virtual_srcspace_f (dcpl_id, index, ds_id, hdferr)
 Gets a dataspace identifier for the selection within the source dataset used in the mapping.
 
subroutine h5pget_virtual_filename_f (dcpl_id, index, name, hdferr, name_len)
 Gets the filename of a source dataset used in the mapping.
 
subroutine h5pget_virtual_dsetname_f (dcpl_id, index, name, hdferr, name_len)
 Gets the name of a source dataset used in the mapping.
 
subroutine h5pget_dset_no_attrs_hint_f (dcpl_id, minimize, hdferr)
 Gets the value of the "minimize dataset headers" value which creates smaller dataset object headers when its set and no attributes are present.
 
subroutine h5pset_dset_no_attrs_hint_f (dcpl_id, minimize, hdferr)
 Sets the value of the "minimize dataset headers" value which creates smaller dataset object headers when its set and no attributes are present.
 
subroutine h5pset_vol_f (plist_id, new_vol_id, hdferr, new_vol_info)
 Set the file VOL connector (VOL_ID) for a file access property list (PLIST_ID)
 
subroutine h5pget_vol_id_f (plist_id, vol_id, hdferr)
 Get the file VOL connector (VOL_ID) for a file access property list (PLIST_ID)
 
subroutine h5pget_vol_cap_flags_f (plist_id, cap_flags, hdferr)
 Query the capability flags for the VOL connector that will be used with this file access property list (FAPL).
 
subroutine h5pget_file_locking_f (fapl_id, use_file_locking, ignore_disabled_locks, hdferr)
 Gets the file locking properties. File locking is mainly used to help enforce SWMR semantics.
 
subroutine h5pset_file_locking_f (fapl_id, use_file_locking, ignore_disabled_locks, hdferr)
 Sets the file locking properties. File locking is mainly used to help enforce SWMR semantics.
 
subroutine h5pget_no_selection_io_cause_f (plist_id, no_selection_io_cause, hdferr)
 Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call.
 
subroutine h5pset_file_space_strategy_f (plist_id, strategy, persist, threshold, hdferr)
 Sets the file space handling strategy and persisting free-space values for a file creation property list.
 
subroutine h5pget_file_space_strategy_f (plist_id, strategy, persist, threshold, hdferr)
 Gets the file space handling strategy and persisting free-space values for a file creation property list.
 
subroutine h5pset_file_space_page_size_f (prp_id, fsp_size, hdferr)
 Sets the file space page size for a file creation property list.
 
subroutine h5pget_file_space_page_size_f (prp_id, fsp_size, hdferr)
 Gets the file space page size for a file creation property list.
 
subroutine h5pget_actual_selection_io_mode_f (plist_id, actual_selection_io_mode, hdferr)
 Retrieves the type(s) of I/O that HDF5 actually performed on raw data during the last I/O call.
 

Variables

integer h5fd_mpio_independent_f
 H5FD_MPIO_INDEPENDENT.
 
integer h5fd_mpio_collective_f
 H5FD_MPIO_COLLECTIVE.
 
integer h5fd_mem_nolist_f
 H5FD_MEM_NOLIST.
 
integer h5fd_mem_default_f
 H5FD_MEM_DEFAULT.
 
integer h5fd_mem_super_f
 H5FD_MEM_SUPER.
 
integer h5fd_mem_btree_f
 H5FD_MEM_BTREE.
 
integer h5fd_mem_draw_f
 H5FD_MEM_DRAW.
 
integer h5fd_mem_gheap_f
 H5FD_MEM_GHEAP.
 
integer h5fd_mem_lheap_f
 H5FD_MEM_LHEAP.
 
integer h5fd_mem_ohdr_f
 H5FD_MEM_OHDR.
 
integer h5fd_mem_ntypes_f
 H5FD_MEM_NTYPES.
 
integer h5fd_subfiling_curr_fapl_version_f
 H5FD_SUBFILING_CURR_FAPL_VERSION.
 
integer h5fd_subfiling_fapl_magic_f
 H5FD_SUBFILING_FAPL_MAGIC.
 
integer h5fd_subfiling_default_stripe_count_f
 H5FD_SUBFILING_DEFAULT_STRIPE_COUNT.
 
integer h5fd_ioc_curr_fapl_version_f
 H5FD_IOC_CURR_FAPL_VERSION.
 
integer h5fd_ioc_fapl_magic_f
 H5FD_IOC_FAPL_MAGIC.
 
integer h5fd_ioc_default_thread_pool_size_f
 H5FD_IOC_DEFAULT_THREAD_POOL_SIZE.
 
integer select_ioc_one_per_node_f
 Default, SELECT_IOC_ONE_PER_NODE.
 
integer select_ioc_every_nth_rank_f
 Starting at rank 0, select-next += N, SELECT_IOC_EVERY_NTH_RANK.
 
integer select_ioc_with_config_f
 NOT IMPLEMENTED: Read-from-file, SELECT_IOC_WITH_CONFIG.
 
integer select_ioc_total_f
 Starting at rank 0, mpi_size / total, SELECT_IOC_TOTAL.
 
integer ioc_selection_options_f
 Sentinel value, IOC_SELECTION_OPTIONS.
 
integer(hid_th5fd_core_f
 H5FD_CORE.
 
integer(hid_th5fd_family_f
 H5FD_FAMILY.
 
integer(hid_th5fd_log_f
 H5FD_LOG.
 
integer(hid_th5fd_mpio_f
 H5FD_MPIO.
 
integer(hid_th5fd_multi_f
 H5FD_MULTI.
 
integer(hid_th5fd_sec2_f
 H5FD_SEC2.
 
integer(hid_th5fd_stdio_f
 H5FD_STDIO.
 
integer(hid_th5fd_subfiling_f
 H5FD_SUBFILING.
 
integer(hid_th5fd_subfiling_default_stripe_size_f
 H5FD_SUBFILING_DEFAULT_STRIPE_SIZE.
 
integer(hid_th5p_file_create_f
 H5P_FILE_CREATE.
 
integer(hid_th5p_file_access_f
 H5P_FILE_ACCESS.
 
integer(hid_th5p_dataset_create_f
 H5P_DATASET_CREATE.
 
integer(hid_th5p_dataset_xfer_f
 H5P_DATASET_XFER.
 
integer(hid_th5p_file_mount_f
 H5P_FILE_MOUNT.
 
integer(hid_th5p_default_f
 H5P_DEFAULT.
 
integer(hid_th5p_root_f
 H5P_ROOT.
 
integer(hid_th5p_object_create_f
 H5P_OBJECT_CREATE.
 
integer(hid_th5p_dataset_access_f
 H5P_DATASET_ACCESS.
 
integer(hid_th5p_group_create_f
 H5P_GROUP_CREATE.
 
integer(hid_th5p_group_access_f
 H5P_GROUP_ACCESS.
 
integer(hid_th5p_datatype_create_f
 H5P_DATATYPE_CREATE.
 
integer(hid_th5p_datatype_access_f
 H5P_DATATYPE_ACCESS.
 
integer(hid_th5p_string_create_f
 H5P_STRING_CREATE.
 
integer(hid_th5p_attribute_create_f
 H5P_ATTRIBUTE_CREATE.
 
integer(hid_th5p_object_copy_f
 H5P_OBJECT_COPY.
 
integer(hid_th5p_link_create_f
 H5P_LINK_CREATE.
 
integer(hid_th5p_link_access_f
 H5P_LINK_ACCESS.
 
integer h5p_crt_order_indexed_f
 H5P_CRT_ORDER_INDEXED.
 
integer h5p_crt_order_tracked_f
 H5P_CRT_ORDER_TRACKED.
 
integer(c_int) ioc_selection
 Method to select I/O concentrators.
 
integer(c_int64_t) stripe_size
 Size (in bytes) of data stripes in subfiles.
 
integer(c_int32_t) stripe_count
 Target number of subfiles to use.
 
integer(c_int32_t) magic
 Set to H5FD_SUBFILING_FAPL_MAGIC_F.
 
integer(c_int32_t) version
 Set to H5FD_CURR_SUBFILING_FAPL_VERSION_F.
 
integer(hid_tioc_fapl_id
 The FAPL setup with the stacked VFD to use for I/O concentrators.
 
logical(c_bool) require_ioc
 Whether to use the IOC VFD (currently must always be TRUE)
 
type(h5fd_subfiling_params_tshared_cfg
 Subfiling/IOC parameters (stripe size, stripe count, etc.)
 
integer(c_int32_t) magic
 Must be set to H5FD_IOC_FAPL_MAGIC_F.
 
integer(c_int32_t) version
 Must be set to H5FD_IOC_CURR_FAPL_VERSION_F.
 
integer(c_int32_t) thread_pool_size
 Number of I/O concentrator worker threads to use.
 

Function/Subroutine Documentation

◆ h5pall_filters_avail_f()

subroutine h5pall_filters_avail_f ( integer(hid_t), intent(in)  prp_id,
logical, intent(out)  flag,
integer, intent(out)  hdferr 
)

Checks if all filters set in the dataset creation property list are available.

Parameters
prp_idData creation property list identifier.
flag.TRUE. if all filters are available, .FALSE. otherwise.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pall_filters_avail()

◆ h5pclose_class_f()

subroutine h5pclose_class_f ( integer(hid_t), intent(in)  class,
integer, intent(out)  hdferr 
)

Closes an existing property list class.

Parameters
classProperty list class identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pclose_class()

◆ h5pclose_f()

subroutine h5pclose_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  hdferr 
)

Terminates access to a property list.

Parameters
prp_idIdentifier of the property list to terminate access to.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pclose()

◆ h5pcopy_f()

subroutine h5pcopy_f ( integer(hid_t), intent(in)  prp_id,
integer(hid_t), intent(out)  new_prp_id,
integer, intent(out)  hdferr 
)

Copies an existing property list to create a new property list.

Parameters
prp_idProperty list identifier.
new_prp_idNew property list identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pcopy()

◆ h5pcopy_prop_f()

subroutine h5pcopy_prop_f ( integer(hid_t), intent(in)  dst_id,
integer(hid_t), intent(in)  src_id,
character(len=*), intent(in)  name,
integer, intent(out)  hdferr 
)

Copies a property from one list or class to another.

Parameters
dst_idIdentifier of the destination property list.
src_idIdentifier of the source property list.
nameName of the property to copy.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pcopy_prop()

◆ h5pcreate_class_f()

subroutine h5pcreate_class_f ( integer(hid_t), intent(in)  parent,
character(len=*), intent(in)  name,
integer(hid_t), intent(out)  class,
integer, intent(out)  hdferr,
type(c_funptr), intent(in), optional  create,
type(c_ptr), intent(in), optional  create_data,
type(c_funptr), intent(in), optional  copy,
type(c_ptr), intent(in), optional  copy_data,
type(c_funptr), intent(in), optional  close,
type(c_ptr), intent(in), optional  close_data 
)

Create a new property list class.

Parameters
parentParent property list class identifier. Possible values include:
  • H5P_ROOT_F
  • H5P_FILE_CREATE_F
  • H5P_FILE_ACCESS_F
  • H5P_DATASET_CREATE_F
  • H5P_DATASET_XFER_F
  • H5P_FILE_MOUNT_F
nameName of property to create.
classProperty list class identifier.
hdferrReturns 0 if successful and -1 if it fails.
create(H5P_cls_create_func_t) - Callback routine called when a property list is created.
create_dataUser pointer to any class creation information needed.
copy(H5P_cls_copy_func_t) - Callback routine called when a property list is copied.
copy_dataUser pointer to any class copy information needed.
close(H5P_cls_close_func_t) - Callback routine called when a property list is being closed.
close_dataUser pointer to any class close information needed.

See C API: H5Pcreate_class()

◆ h5pcreate_f()

subroutine h5pcreate_f ( integer(hid_t), intent(in)  class,
integer(hid_t), intent(out)  prp_id,
integer, intent(out)  hdferr 
)

Creates a new property as an instance of a property list class.

Parameters
classType of the property class to be created. Possible values are:
  • H5P_OBJECT_CREATE_F
  • H5P_FILE_CREATE_F
  • H5P_FILE_ACCESS_F
  • H5P_DATASET_CREATE_F
  • H5P_DATASET_ACCESS_F
  • H5P_DATASET_XFER_F
  • H5P_FILE_MOUNT_F
  • H5P_GROUP_CREATE_F
  • H5P_GROUP_ACCESS_F
  • H5P_DATATYPE_CREATE_F
  • H5P_DATATYPE_ACCESS_F
  • H5P_STRING_CREATE_F
  • H5P_ATTRIBUTE_CREATE _F
  • H5P_OBJECT_COPY_F
  • H5P_LINK_CREATE_F
  • H5P_LINK_ACCESS_F
prp_idProperty list identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pcreate()

◆ h5pequal_f()

subroutine h5pequal_f ( integer(hid_t), intent(in)  plist1_id,
integer(hid_t), intent(in)  plist2_id,
logical, intent(out)  flag,
integer, intent(out)  hdferr 
)

Checks if two property lists are equal.

Parameters
plist1_idProperty list identifier.
plist2_idProperty list identifier.
flagFlag, Possible values: .TRUE. or .FALSE.
hdferrReturns 0 if successful and -1 if it fails. and flag is set to .FALSE.

See C API: H5Pequal()

◆ h5pexist_f()

subroutine h5pexist_f ( integer(hid_t), intent(in)  prp_id,
character(len=*), intent(in)  name,
logical, intent(out)  flag,
integer, intent(out)  hdferr 
)

Queries whether a property name exists in a property list or class.

Parameters
prp_idProperty list identifier to query.
nameName of property to check for.
flagLogical flag.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pexist()

◆ h5pfill_value_defined_f()

subroutine h5pfill_value_defined_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(out)  flag,
integer, intent(out)  hdferr 
)

Check if fill value is defined.

Parameters
plist_idDataset creation property list identifier.
flagFill value status flag. Possible values are:
  • H5D_FILL_VALUE_ERROR_F
  • H5D_FILL_VALUE_UNDEFINED_F
  • H5D_FILL_VALUE_DEFAULT_F
  • H5D_FILL_VALUE_USER_DEFINED_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pfill_value_defined()

◆ h5pget_actual_selection_io_mode_f()

subroutine h5pget_actual_selection_io_mode_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(out)  actual_selection_io_mode,
integer, intent(out)  hdferr 
)

Retrieves the type(s) of I/O that HDF5 actually performed on raw data during the last I/O call.

Parameters
plist_idFile creation property list identifier
actual_selection_io_modeA bitwise set value indicating the type(s) of I/O performed
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_actual_selection_io_mode()

◆ h5pget_alignment_f()

subroutine h5pget_alignment_f ( integer(hid_t), intent(in)  prp_id,
integer(hsize_t), intent(out)  threshold,
integer(hsize_t), intent(out)  alignment,
integer, intent(out)  hdferr 
)

Retrieves the current settings for alignment properties from a file access property list.

Parameters
prp_idFile access property list identifier.
thresholdThreshold value.
alignmentAlignment value.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_alignment()

◆ h5pget_all_coll_metadata_ops_f()

subroutine h5pget_all_coll_metadata_ops_f ( integer(hid_t), intent(in)  plist_id,
logical, intent(out)  is_collective,
integer, intent(out)  hdferr 
)

Retrieves metadata read mode from the access property list.

Parameters
plist_idFile access property list identifier.
is_collectiveCollective access setting.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_all_coll_metadata_ops()

◆ h5pget_alloc_time_f()

subroutine h5pget_alloc_time_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(out)  flag,
integer, intent(out)  hdferr 
)

Get space allocation time for dataset during creation.

Parameters
plist_idDataset creation property list identifier.
flagAllocation time flag. Possible values are:
  • H5D_ALLOC_TIME_ERROR_F
  • H5D_ALLOC_TIME_DEFAULT_F
  • H5D_ALLOC_TIME_EARLY_F
  • H5D_ALLOC_TIME_LATE_F
  • H5D_ALLOC_TIME_INCR_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_alloc_time()

◆ h5pget_attr_creation_order_f()

subroutine h5pget_attr_creation_order_f ( integer(hid_t), intent(in)  ocpl_id,
integer, intent(out)  crt_order_flags,
integer, intent(out)  hdferr 
)

Retrieves tracking and indexing settings for attribute creation order.

Parameters
ocpl_idObject (group or dataset) creation property list identifier.
crt_order_flagsFlags specifying whether to track and index attribute creation order.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_attr_creation_order()

◆ h5pget_attr_phase_change_f()

subroutine h5pget_attr_phase_change_f ( integer(hid_t), intent(in)  ocpl_id,
integer, intent(out)  max_compact,
integer, intent(out)  min_dense,
integer, intent(out)  hdferr 
)

Retrieves attribute storage phase change thresholds.

Parameters
ocpl_idObject (dataset or group) creation property list identifier.
max_compactMaximum number of attributes to be stored in compact storage (Default: 8).
min_denseMinimum number of attributes to be stored in dense storage (Default: 6).
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_attr_phase_change()

◆ h5pget_btree_ratios_f()

subroutine h5pget_btree_ratios_f ( integer(hid_t), intent(in)  prp_id,
real, intent(out)  left,
real, intent(out)  middle,
real, intent(out)  right,
integer, intent(out)  hdferr 
)

Gets B-tree split ratios for a dataset transfer property list.

Parameters
prp_idThe dataset transfer property list identifier.
leftThe B-tree split ratio for left-most nodes.
middleThe B-tree split ratio for all other nodes.
rightThe B-tree split ratio for right-most nodes.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_btree_ratios()

◆ h5pget_buffer_f()

subroutine h5pget_buffer_f ( integer(hid_t), intent(in)  plist_id,
integer(hsize_t), intent(out)  size,
integer, intent(out)  hdferr 
)

Gets size for conversion buffer.

Parameters
plist_idData transfer property list identifier.
sizeBuffer size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_buffer()

◆ h5pget_cache_f()

subroutine h5pget_cache_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  mdc_nelmts,
integer(size_t), intent(out)  rdcc_nelmts,
integer(size_t), intent(out)  rdcc_nbytes,
real, intent(out)  rdcc_w0,
integer, intent(out)  hdferr 
)

Queries the meta data cache and raw data chunk cache parameters.

Parameters
prp_idFile access property list identifier.
mdc_nelmtsNumber of elements (objects) in the metadata cache
rdcc_nelmtsNumber of elements (objects) in the raw data chunk cache
rdcc_nbytesTotal size of the raw data chunk cache, in bytes.
rdcc_w0Preemption policy (0 or 1).
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_cache()

◆ h5pget_char_encoding_f()

subroutine h5pget_char_encoding_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(out)  encoding,
integer, intent(out)  hdferr 
)

Retrieves the character encoding used to create a string.

Parameters
plist_idProperty list identifier.
encodingValid values for encoding are:
  • H5T_CSET_ASCII_F -> US ASCII
  • H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_char_encoding()

◆ h5pget_chunk_cache_f()

subroutine h5pget_chunk_cache_f ( integer(hid_t), intent(in)  dapl_id,
integer(size_t), intent(out)  rdcc_nslots,
integer(size_t), intent(out)  rdcc_nbytes,
real, intent(out)  rdcc_w0,
integer, intent(out)  hdferr 
)

Retrieves the raw data chunk cache parameters.

Parameters
dapl_idDataset access property list identifier.
rdcc_nslotsNumber of chunk slots in the raw data chunk cache hash table.
rdcc_nbytesTotal size of the raw data chunk cache, in bytes.
rdcc_w0Preemption policy.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_chunk_cache()

◆ h5pget_chunk_f()

subroutine h5pget_chunk_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  ndims,
integer(hsize_t), dimension(ndims), intent(out)  dims,
integer, intent(out)  hdferr 
)

Retrieves the size of chunks for the raw data of a chunked layout dataset.

Parameters
prp_idProperty list identifier.
ndimsSize of dims array.
dimsArray with dimension sizes for each chunk.
hdferrReturns number of chunk dimensions if successful and -1 if fails.

See C API: H5Pget_chunk()

◆ h5pget_class_f()

subroutine h5pget_class_f ( integer(hid_t), intent(in)  prp_id,
integer(hid_t), intent(out)  classtype,
integer, intent(out)  hdferr 
)

Returns the property list class for a property list.

Parameters
prp_idProperty list identifier.
classtypeProperty list class.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_class()

◆ h5pget_class_name_f()

subroutine h5pget_class_name_f ( integer(hid_t), intent(in)  prp_id,
character(len=*), intent(out)  name,
integer, intent(out)  size,
integer, intent(out)  hdferr 
)

Queries the name of a class.

Parameters
prp_idProperty list identifier to query.
nameName of a class.
sizeActual length of the class name. NOTE: If provided buffer "name" is smaller, than name will be truncated to fit into provided user buffer.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_class_name()

◆ h5pget_class_parent_f()

subroutine h5pget_class_parent_f ( integer(hid_t), intent(in)  prp_id,
integer(hid_t), intent(out)  parent_id,
integer, intent(out)  hdferr 
)

Retrieves the parent class of a generic property class.

Parameters
prp_idProperty list identifier to query.
parent_idIdentifier of the parent class.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_class_parent()

◆ h5pget_coll_metadata_write_f()

subroutine h5pget_coll_metadata_write_f ( integer(hid_t), intent(in)  plist_id,
logical, intent(out)  is_collective,
integer, intent(out)  hdferr 
)

Retrieves metadata write mode from the file access property list.

Parameters
plist_idFile access property list identifier.
is_collectiveCollective access setting.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_coll_metadata_write()

◆ h5pget_copy_object_f()

subroutine h5pget_copy_object_f ( integer(hid_t), intent(in)  ocp_plist_id,
integer, intent(out)  copy_options,
integer, intent(out)  hdferr 
)

Retrieves the properties to be used when an object is copied.

Parameters
ocp_plist_idObject copy property list identifier.
copy_optionsCopy option(s) to be get.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_copy_object()

◆ h5pget_create_inter_group_f()

subroutine h5pget_create_inter_group_f ( integer(hid_t), intent(in)  lcpl_id,
integer, intent(in)  crt_intermed_group,
integer, intent(out)  hdferr 
)

Determines whether property is set to enable creating missing intermediate groups.

Parameters
lcpl_idLink creation property list identifier.
crt_intermed_groupSpecifying whether to create intermediate groups upon the creation of an object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_create_intermediate_group()

◆ h5pget_data_transform_f()

subroutine h5pget_data_transform_f ( integer(hid_t), intent(in)  plist_id,
character(len=*), intent(out)  expression,
integer, intent(out)  hdferr,
integer(size_t), intent(out), optional  size 
)

Retrieves a data transform expression.

Parameters
plist_idIdentifier of the property list or class.
expressionBuffer to hold transform expression.
hdferrError code: Success: Actual length of the expression. If provided buffer "expression" is smaller, than expression will be truncated to fit into provided user buffer. Failure: -1
sizeRegistered size of the transform expression

See C API: H5Pget_data_transform()

◆ h5pget_driver_f()

subroutine h5pget_driver_f ( integer(hid_t), intent(in)  prp_id,
integer(hid_t), intent(out)  driver,
integer, intent(out)  hdferr 
)

Returns low-lever driver identifier.

Parameters
prp_idFile access or data transfer property list identifier.
driverLow-level driver identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_driver()

◆ h5pget_dset_no_attrs_hint_f()

subroutine h5pget_dset_no_attrs_hint_f ( integer(hid_t), intent(in)  dcpl_id,
logical, intent(out)  minimize,
integer, intent(out)  hdferr 
)

Gets the value of the "minimize dataset headers" value which creates smaller dataset object headers when its set and no attributes are present.

Parameters
dcpl_idTarget dataset creation property list identifier.
minimizeValue of the setting.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_dset_no_attrs_hint()

◆ h5pget_dxpl_mpio_f()

subroutine h5pget_dxpl_mpio_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  data_xfer_mode,
integer, intent(out)  hdferr 
)

Returns the data transfer mode.

Parameters
prp_idData transfer property list identifier.
data_xfer_modeTransfer mode; possible values are:
  • H5FD_MPIO_INDEPENDENT_F
  • H5FD_MPIO_COLLECTIVE_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_dxpl_mpio()

◆ h5pget_edc_check_f()

subroutine h5pget_edc_check_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  flag,
integer, intent(out)  hdferr 
)

Determines whether error-detection is enabled for dataset reads.

Parameters
prp_idDataset creation property list identifier.
flagEDC flag; possible values:
  • H5Z_DISABLE_EDC_F
  • H5Z_ENABLE_EDC_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_edc_check()

◆ h5pget_est_link_info_f()

subroutine h5pget_est_link_info_f ( integer(hid_t), intent(in)  gcpl_id,
integer, intent(out)  est_num_entries,
integer, intent(out)  est_name_len,
integer, intent(out)  hdferr 
)

Queries data required to estimate required local heap or object header size.

Parameters
gcpl_idGroup creation property list identifier.
est_num_entriesEstimated number of links to be inserted into group.
est_name_lenEstimated average length of link names.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_est_link_info()

◆ h5pget_external_count_f()

subroutine h5pget_external_count_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  count,
integer, intent(out)  hdferr 
)

Returns the number of external files for a dataset.

Parameters
prp_idDataset creation property list identifier.
countNumber of external files for the specified dataset.
hdferrReturns 0 if successful and -1 if it fails.

See C API: int H5Pget_external_count(hid_t plist_id);

◆ h5pget_external_f()

subroutine h5pget_external_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  idx,
integer(size_t), intent(in)  name_size,
character(len=*), intent(out)  name,
integer(off_t), intent(out)  offset,
integer(hsize_t), intent(out)  bytes,
integer, intent(out)  hdferr 
)

Returns information about an external file.

Parameters
prp_idDataset creation property list identifier.
idxExternal file index.
name_sizeMaximum size of name array.
nameName of the external file.
offsetOffset in bytes from the beginning of the file to the location in the file where the data starts.
bytesSize of the external file data.
hdferrReturns 0 if successful and -1 if it fails.
Note
On Windows, off_t is typically a 32-bit signed long value, which limits the valid offset that can be returned to 2 GiB.

See C API: H5Pget_external()

◆ h5pget_f() [1/2]

subroutine h5pget_f ( integer(hid_t), intent(in)  prp_id,
character(len=*), intent(in)  name,
type(c_ptr), intent(in)  value,
integer, intent(out)  hdferr 
)

Queries the value of a property.

Attention
The preferred API, Fortran 2003 version.
Parameters
prp_idProperty list identifier to modify.
nameName of property to get.
valuePointer to a location to which to copy the value of of the property.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget()

◆ h5pget_f() [2/2]

subroutine h5pget_f ( integer(hid_t), intent(in)  prp_id,
character(len=*), intent(in)  name,
integer, intent(out)  value,
integer, intent(out)  hdferr 
)

Queries the value of a property.

Attention
Obsolete API, use the Fortran 2003 version instead.
Parameters
prp_idProperty list identifier to modify.
nameName of property to get.
valueProperty value, supported types are:
  • INTEGER
  • REAL
  • DOUBLE PRECISION
  • CHARACTER(LEN=*)
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget()

◆ h5pget_fapl_core_f()

subroutine h5pget_fapl_core_f ( integer(hid_t), intent(in)  prp_id,
integer(size_t), intent(out)  increment,
logical, intent(out)  backing_store,
integer, intent(out)  hdferr 
)

Queries core file driver properties.

Parameters
prp_idFile access property list identifier.
incrementSize, in bytes, of memory increments.
backing_storeBoolean flag indicating whether to write the file contents to disk when the file is closed.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_fapl_core()

◆ h5pget_fapl_direct_f()

subroutine h5pget_fapl_direct_f ( integer(hid_t), intent(in)  fapl_id,
integer(size_t), intent(out)  alignment,
integer(size_t), intent(out)  block_size,
integer(size_t), intent(out)  cbuf_size,
integer, intent(out)  hdferr 
)

Gets up use of the direct I/O driver.

Parameters
fapl_idFile access property list identifier.
alignmentRequired memory alignment boundary.
block_sizeFile system block size.
cbuf_sizeCopy buffer size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_fapl_direct()

◆ h5pget_fapl_family_f()

subroutine h5pget_fapl_family_f ( integer(hid_t), intent(in)  prp_id,
integer(hsize_t), intent(out)  memb_size,
integer(hid_t), intent(out)  memb_plist,
integer, intent(out)  hdferr 
)

Returns file access property list information.

Parameters
prp_idFile access property list identifier.
memb_sizeSize in bytes of each file member.
memb_plistIdentifier of the file access property list to be used for each family member
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_fapl_family()

◆ h5pget_fapl_ioc_f()

subroutine h5pget_fapl_ioc_f ( integer(hid_t), intent(in)  prp_id,
type(h5fd_ioc_config_t), target  vfd_config,
integer, intent(out)  hdferr 
)

Queries a File Access Property List for H5FD_IOC file driver properties.

Parameters
prp_idFile access property list identifier.
vfd_configH5FD_IOC driver configuration derived type.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_fapl_ioc()

◆ h5pget_fapl_mpio_f() [1/2]

subroutine h5pget_fapl_mpio_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  comm,
integer, intent(out)  info,
integer, intent(out)  hdferr 
)

Returns MPI communicator information.

Parameters
prp_idFile access property list identifier.
commMPI-2 communicator.
infoMPI-2 info object.
hdferrReturns 0 if successful and -1 if it fails.
Attention
It is the responsibility of the application to free the MPI objects.

See C API: H5Pget_fapl_mpio()

◆ h5pget_fapl_mpio_f() [2/2]

subroutine h5pget_fapl_mpio_f ( integer(hid_t), intent(in)  prp_id,
type(mpi_comm), intent(out)  comm,
type(mpi_info), intent(out)  info,
integer, intent(out)  hdferr 
)

Returns MPI communicator information.

Note
Supports MPI Fortran module mpi_f08
Parameters
prp_idFile access property list identifier.
commMPI-3 communicator.
infoMPI-3 info object.
hdferrReturns 0 if successful and -1 if it fails.
Attention
It is the responsibility of the application to free the MPI objects.

See C API: H5Pget_fapl_mpio()

◆ h5pget_fapl_subfiling_f()

subroutine h5pget_fapl_subfiling_f ( integer(hid_t), intent(in)  prp_id,
type(h5fd_subfiling_config_t), target  vfd_config,
integer, intent(out)  hdferr 
)

Queries a File Access Property List for H5FD_SUBFILING file driver properties.

Parameters
prp_idFile access property list identifier.
vfd_configH5FD_SUBFILING driver configuration derived type.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_fapl_subfiling()

◆ h5pget_fclose_degree_f()

subroutine h5pget_fclose_degree_f ( integer(hid_t), intent(in)  fapl_id,
integer, intent(out)  degree,
integer, intent(out)  hdferr 
)

Returns the degree for the file close behavior.

Parameters
fapl_idFile access property list identifier.
degreePossible values are:
  • H5F_CLOSE_DEFAULT_F
  • H5F_CLOSE_WEAK_F
  • H5F_CLOSE_SEMI_F
  • H5F_CLOSE_STRONG_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_fclose_degree()

◆ h5pget_file_image_f()

subroutine h5pget_file_image_f ( integer(hid_t), intent(in)  fapl_id,
type(c_ptr), dimension(*), intent(in)  buf_ptr,
integer(size_t), intent(out)  buf_len_ptr,
integer, intent(out)  hdferr 
)

Retrieves a copy of the file image designated as the initial content and structure of a file.

Parameters
fapl_idFile access property list identifier.
buf_ptrWill hold either a C_NULL_PTR or a scalar of type c_loc. If buf_ptr is not C_NULL_PTR, on successful return, buf_ptr shall contain a C pointer to a copy of the initial image provided in the last call to H5Pset_file_image_f for the supplied fapl_id, or buf_ptr shall contain a C_NULL_PTR if there is no initial image set.
buf_len_ptrContains the value of the buffer parameter for the initial image in the supplied fapl_id. The value will be 0 if no initial image is set.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_file_image()

◆ h5pget_file_locking_f()

subroutine h5pget_file_locking_f ( integer(hid_t), intent(in)  fapl_id,
logical, intent(out)  use_file_locking,
logical, intent(out)  ignore_disabled_locks,
integer, intent(out)  hdferr 
)

Gets the file locking properties. File locking is mainly used to help enforce SWMR semantics.

Parameters
fapl_idTarget fileTarget file access property list identifier.
use_file_lockingWhether or not to use file locks.
ignore_disabled_locksWhether or not to ignore file locks when locking is disabled on a file system.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_file_locking()

◆ h5pget_file_space_page_size_f()

subroutine h5pget_file_space_page_size_f ( integer(hid_t), intent(in)  prp_id,
integer(hsize_t), intent(out)  fsp_size,
integer, intent(out)  hdferr 
)

Gets the file space page size for a file creation property list.

Parameters
prp_idFile creation property list identifier
fsp_sizeFile space page size
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_file_space_page_size()

◆ h5pget_file_space_strategy_f()

subroutine h5pget_file_space_strategy_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(out)  strategy,
logical, intent(out)  persist,
integer(hsize_t), intent(out)  threshold,
integer, intent(out)  hdferr 
)

Gets the file space handling strategy and persisting free-space values for a file creation property list.

Parameters
plist_idFile creation property list identifier
strategyThe file space handling strategy to be used
persistIndicate whether free space should be persistent or not
thresholdThe free-space section size threshold value
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_file_space_strategy()

◆ h5pget_fill_time_f()

subroutine h5pget_fill_time_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(out)  flag,
integer, intent(out)  hdferr 
)

Get fill value writing time for dataset.

Parameters
plist_idDataset creation property list identifier.
flagFill time flag. Possible values are:
  • H5D_FILL_TIME_ERROR_F
  • H5D_FILL_TIME_ALLOC_F
  • H5D_FILL_TIME_NEVER_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_fill_time()

◆ h5pget_fill_value_f() [1/2]

subroutine h5pget_fill_value_f ( integer(hid_t), intent(in)  prp_id,
integer(hid_t), intent(in)  type_id,
type(c_ptr), intent(in)  fillvalue,
integer, intent(out)  hdferr 
)

Gets fill value for a dataset creation property list.

Attention
The preferred API, Fortran 2003 version.
Parameters
prp_idProperty list identifier.
type_idDatatype identifier of fill value datatype (in memory).
fillvalueFillvalue.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_fill_value()

◆ h5pget_fill_value_f() [2/2]

subroutine h5pget_fill_value_f ( integer(hid_t), intent(in)  prp_id,
integer(hid_t), intent(in)  type_id,
type(type), intent(out)  fillvalue,
integer, intent(out)  hdferr 
)

Gets fill value for a dataset creation property list.

Attention
Obsolete API, use the Fortran 2003 version instead.
Parameters
prp_idProperty list identifier.
type_idDatatype identifier of fill value datatype (in memory).
fillvalueFillvalue.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_fill_value()

◆ h5pget_filter_by_id_f()

subroutine h5pget_filter_by_id_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  filter_id,
integer, intent(out)  flags,
integer(size_t), intent(inout)  cd_nelmts,
integer, dimension(*), intent(out)  cd_values,
integer(size_t), intent(in)  namelen,
character(len=*), intent(out)  name,
integer, intent(out)  hdferr 
)

Returns information about a filter in a pipeline.

Parameters
prp_idData creation or transfer property list identifier
filter_idFilter identifier.
flagsBit vector specifying certain general properties of the filter
cd_nelmtsNumber of elements in cd_values.
cd_valuesAuxiliary data for the filter.
namelenNumber of characters in the name buffer.
nameBuffer to retrieve filter name.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_filter_by_id2()

◆ h5pget_filter_f()

subroutine h5pget_filter_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  filter_number,
integer, intent(out)  flags,
integer(size_t), intent(inout)  cd_nelmts,
integer, dimension(*), intent(out)  cd_values,
integer(size_t), intent(in)  namelen,
character(len=*), intent(out)  name,
integer, intent(out)  filter_id,
integer, intent(out)  hdferr 
)

Returns information about a filter in a pipeline.

Parameters
prp_idData creation or transfer property list identifier
filter_numberSequence number within the filter pipeline of the filter for which information is sought
filter_idFilter identification number.
flagsBitbit vector specifying certain general properties of the filter.
cd_nelmtsNumber of elements in cd_values.
cd_valuesAuxiliary data for the filter.
namelenNumber of characters in the name buffer.
nameBuffer to retrieve filter name.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_filter2()

◆ h5pget_gc_references_f()

subroutine h5pget_gc_references_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  gc_reference,
integer, intent(out)  hdferr 
)

Returns garbage collecting references setting.

Parameters
prp_idFile access property list identifier.
gc_referenceFlag for setting garbage collection on and off (1 or 0)
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_gc_references()

◆ h5pget_hyper_vector_size_f()

subroutine h5pget_hyper_vector_size_f ( integer(hid_t), intent(in)  plist_id,
integer(size_t), intent(out)  size,
integer, intent(out)  hdferr 
)

Get the number of "I/O" vectors (vector size)

Parameters
plist_idDataset transfer property list identifier.
sizeVector size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_hyper_vector_size()

◆ h5pget_istore_k_f()

subroutine h5pget_istore_k_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  ik,
integer, intent(out)  hdferr 
)

Queries the 1/2 rank of an indexed storage B-tree.

Parameters
prp_idFile creation property list identifier.
ikRank of chunked storage B-tree.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_istore_k()

◆ h5pget_layout_f()

subroutine h5pget_layout_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  layout,
integer, intent(out)  hdferr 
)

Returns the layout of the raw data for a dataset.

Parameters
prp_idData creation property list identifier.
layoutType of storage layout for raw data. Possible values are:
  • H5D_COMPACT_F
  • H5D_CONTIGUOUS_F
  • H5D_CHUNKED_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_layout()

◆ h5pget_libver_bounds_f()

subroutine h5pget_libver_bounds_f ( integer(hid_t), intent(in)  fapl_id,
integer, intent(out)  low,
integer, intent(out)  high,
integer, intent(out)  hdferr 
)

Retrieves the lower and upper bounds on the HDF5 library release versions that indirectly determine the object format versions used when creating objects in the file.

Parameters
fapl_idFile access property list identifier.
lowThe earliest version of the library that will be used for writing objects.
highThe latest version of the library that will be used for writing objects.
hdferrReturns 0 if successful and -1 if it fails.

Fortran Interface: See C API: H5Pget_libver_bounds()

◆ h5pget_link_creation_order_f()

subroutine h5pget_link_creation_order_f ( integer(hid_t), intent(in)  gcpl_id,
integer, intent(out)  crt_order_flags,
integer, intent(out)  hdferr 
)

Queries whether link creation order is tracked and/or indexed in a group.

Parameters
gcpl_idGroup creation property list identifier.
crt_order_flagsCreation order flag(s).
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_link_creation_order()

◆ h5pget_link_phase_change_f()

subroutine h5pget_link_phase_change_f ( integer(hid_t), intent(in)  gcpl_id,
integer, intent(out)  max_compact,
integer, intent(out)  min_dense,
integer, intent(out)  hdferr 
)

Queries the settings for conversion between compact and dense groups.

Parameters
gcpl_idGroup creation property list identifier.
max_compactMaximum number of attributes to be stored in compact storage.
min_denseMinimum number of attributes to be stored in dense storage.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_link_phase_change()

◆ h5pget_local_heap_size_hint_f()

subroutine h5pget_local_heap_size_hint_f ( integer(hid_t), intent(in)  gcpl_id,
integer(size_t), intent(out)  size_hint,
integer, intent(out)  hdferr 
)

Queries the local heap size hint for original-style groups.

Parameters
gcpl_idGroup creation property list identifier.
size_hintHint for size of local heap.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_local_heap_size_hint()

◆ h5pget_meta_block_size_f()

subroutine h5pget_meta_block_size_f ( integer(hid_t), intent(in)  plist_id,
integer(hsize_t), intent(out)  size,
integer, intent(out)  hdferr 
)

Gets the minimum size of metadata block allocations.

Parameters
plist_idFile access property list identifier.
sizeMetadata block size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_meta_block_size()

◆ h5pget_modify_write_buf_f()

subroutine h5pget_modify_write_buf_f ( integer(hid_t), intent(in)  plist_id,
logical, intent(out)  modify_write_buf,
integer, intent(out)  hdferr 
)

Retrieves the "modify write buffer" property.

Parameters
plist_idProperty list identifier
modify_write_bufWhether the library can modify the contents of the write buffer
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_modify_write_buf()

◆ h5pget_mpi_params_f() [1/2]

subroutine h5pget_mpi_params_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  comm,
integer, intent(out)  info,
integer, intent(out)  hdferr 
)

Get the MPI communicator and info.

Parameters
prp_idFile access property list identifier.
commMPI-2 communicator.
infoMPI-2 info object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_mpi_params()

◆ h5pget_mpi_params_f() [2/2]

subroutine h5pget_mpi_params_f ( integer(hid_t), intent(in)  prp_id,
type(mpi_comm), intent(out)  comm,
type(mpi_info), intent(out)  info,
integer, intent(out)  hdferr 
)

Get the MPI communicator and information.

Note
Supports MPI Fortran module mpi_f08
Parameters
prp_idFile access property list identifier.
commMPI-3 communicator.
infoMPI-3 info object.
hdferrReturns 0 if successful and -1 if it fails.
Attention
It is the responsibility of the application to free the MPI objects.

See C API: H5Pget_mpi_params()

◆ h5pget_mpio_actual_io_mode_f()

subroutine h5pget_mpio_actual_io_mode_f ( integer(hid_t), intent(in)  dxpl_id,
integer, intent(out)  actual_io_mode,
integer, intent(out)  hdferr 
)

Retrieves the type of I/O that HDF5 actually performed on the last parallel I/O call. This is not necessarily the type of I/O requested.

Parameters
dxpl_idDataset transfer property list identifier.
actual_io_modeThe type of I/O performed by this process.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_mpio_actual_io_mode()

◆ h5pget_mpio_no_collective_cause_f()

subroutine h5pget_mpio_no_collective_cause_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(out)  local_no_collective_cause,
integer, intent(out)  global_no_collective_cause,
integer, intent(out)  hdferr 
)

Retrieves local and global causes that broke collective I/O on the last parallel I/O call.

Parameters
plist_idDataset transfer property list identifier
local_no_collective_causeAn enumerated set value indicating the causes that prevented collective I/O in the local process
global_no_collective_causeAn enumerated set value indicating the causes across all processes that prevented collective I/O
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_mpio_no_collective_cause()

◆ h5pget_nfilters_f()

subroutine h5pget_nfilters_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  nfilters,
integer, intent(out)  hdferr 
)

Returns the number of filters in the pipeline.

Parameters
prp_idData creation or transfer property list identifier.
nfiltersNumber of filters in the pipeline.
hdferrReturns 0 if successful and -1 if it fails.

◆ h5pget_nlinks_f()

subroutine h5pget_nlinks_f ( integer(hid_t), intent(in)  lapl_id,
integer(size_t), intent(out)  nlinks,
integer, intent(out)  hdferr 
)

Gets maximum number of soft or user-defined link traversals.

Parameters
lapl_idFile access property list identifier.
nlinksMaximum number of links to traverse.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_nlinks()

◆ h5pget_no_selection_io_cause_f()

subroutine h5pget_no_selection_io_cause_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(out)  no_selection_io_cause,
integer, intent(out)  hdferr 
)

Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call.

Parameters
plist_idDataset transfer property list identifier
no_selection_io_causeA bitwise set value indicating the relevant causes that prevented selection I/O from being performed
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_no_selection_io_cause()

◆ h5pget_nprops_f()

subroutine h5pget_nprops_f ( integer(hid_t), intent(in)  prp_id,
integer(size_t), intent(out)  nprops,
integer, intent(out)  hdferr 
)

Queries number of properties in property list or class.

Parameters
prp_idIproperty list identifier to query.
npropsNumber of properties in property object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_nprops()

◆ h5pget_obj_track_times_f()

subroutine h5pget_obj_track_times_f ( integer(hid_t), intent(in)  plist_id,
logical, intent(out)  flag,
integer, intent(out)  hdferr 
)

Returns whether times are tracked for an object.

Parameters
plist_idProperty list id.
flagObject timestamp setting, .TRUE. or .FALSE.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_obj_track_times()

◆ h5pget_preserve_f()

subroutine h5pget_preserve_f ( integer(hid_t), intent(in)  prp_id,
logical, intent(out)  flag,
integer, intent(out)  hdferr 
)

Checks status of the dataset transfer property list.

Parameters
prp_idProperty list identifier.
flagStatus flag.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_preserve()

◆ h5pget_selection_io_f()

subroutine h5pget_selection_io_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(out)  selection_io_mode,
integer, intent(out)  hdferr 
)

Retrieves the selection I/O mode.

Parameters
plist_idProperty list identifier
selection_io_modeThe selection I/O mode
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_selection_io()

◆ h5pget_sieve_buf_size_f()

subroutine h5pget_sieve_buf_size_f ( integer(hid_t), intent(in)  plist_id,
integer(size_t), intent(out)  size,
integer, intent(out)  hdferr 
)

Gets the maximum size of the data sieve buffer.

Parameters
plist_idFile access property list identifier.
sizeSieve buffer size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_sieve_buf_size()

◆ h5pget_size_f()

subroutine h5pget_size_f ( integer(hid_t), intent(in)  prp_id,
character(len=*), intent(in)  name,
integer(size_t), intent(out)  size,
integer, intent(out)  hdferr 
)

Queries the size of a property value in bytes.

Parameters
prp_idProperty list identifier to query.
nameName of property to query.
sizeSize of property in bytes.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_size()

◆ h5pget_sizes_f()

subroutine h5pget_sizes_f ( integer(hid_t), intent(in)  prp_id,
integer(size_t), intent(out)  sizeof_addr,
integer(size_t), intent(out)  sizeof_size,
integer, intent(out)  hdferr 
)

Retrieves the size of the offsets and lengths used in an HDF5 file.

Parameters
prp_idFile Creation property list identifier.
sizeof_addrSize of an object offset in bytes.
sizeof_sizeSize of an object length in bytes.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_sizes()

◆ h5pget_small_data_block_size_f()

subroutine h5pget_small_data_block_size_f ( integer(hid_t), intent(in)  plist_id,
integer(hsize_t), intent(out)  size,
integer, intent(out)  hdferr 
)

Gets the minimum size of "small" raw data block.

Parameters
plist_idFile access property list identifier.
sizeSmall raw data block size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_small_data_block_size()

◆ h5pget_sym_k_f()

subroutine h5pget_sym_k_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  ik,
integer, intent(out)  lk,
integer, intent(out)  hdferr 
)

Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size.

Parameters
prp_idFile creation property list identifier.
ikSymbol table tree 1/2 rank.
lkSymbol table node 1/2 size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_sym_k()

◆ h5pget_userblock_f()

subroutine h5pget_userblock_f ( integer(hid_t), intent(in)  prp_id,
integer(hsize_t), intent(out)  block_size,
integer, intent(out)  hdferr 
)

Gets user block size.

Parameters
prp_idFile creation property list identifier.
block_sizeSize of the user block in bytes.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_userblock()

◆ h5pget_version_f()

subroutine h5pget_version_f ( integer(hid_t), intent(in)  prp_id,
integer, dimension(*), intent(out)  boot,
integer, dimension(*), intent(out)  freelist,
integer, dimension(*), intent(out)  stab,
integer, dimension(*), intent(out)  shhdr,
integer, intent(out)  hdferr 
)

Retrieves the version information of various objects for a file creation property list.

Parameters
prp_idFile creation property list identifier.
bootSuper block version number.
freelistGlobal freelist version number.
stabSymbol table version number.
shhdrShared object header version number.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_version()

◆ h5pget_virtual_count_f()

subroutine h5pget_virtual_count_f ( integer(hid_t), intent(in)  dcpl_id,
integer(size_t), intent(out)  count,
integer, intent(out)  hdferr 
)

Gets the number of mappings for the virtual dataset.

Parameters
dcpl_idThe identifier of the virtual dataset creation property list.
countThe number of mappings.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_virtual_count()

◆ h5pget_virtual_dsetname_f()

subroutine h5pget_virtual_dsetname_f ( integer(hid_t), intent(in)  dcpl_id,
integer(size_t), intent(in)  index,
character(len=*), intent(out)  name,
integer, intent(out)  hdferr,
integer(size_t), optional  name_len 
)

Gets the name of a source dataset used in the mapping.

Parameters
dcpl_idThe identifier of the virtual dataset creation property list.
indexMapping index. The value of index is 0 (zero) or greater and less than count (0 ≤ index < count), where count is the number of mappings returned by h5pget_virtual_count.
nameA buffer containing the name of the source dataset.
hdferrReturns 0 if successful and -1 if it fails.
name_lenThe size of name needed to hold the source dataset name.

See C API: H5Pget_virtual_dsetname()

◆ h5pget_virtual_filename_f()

subroutine h5pget_virtual_filename_f ( integer(hid_t), intent(in)  dcpl_id,
integer(size_t), intent(in)  index,
character(len=*), intent(out)  name,
integer, intent(out)  hdferr,
integer(size_t), optional  name_len 
)

Gets the filename of a source dataset used in the mapping.

Parameters
dcpl_idThe identifier of the virtual dataset creation property list.
indexMapping index. The value of index is 0 (zero) or greater and less than count (0 ≤ index < count), where count is the number of mappings returned by h5pget_virtual_count.
nameA buffer containing the name of the file containing the source dataset.
hdferrReturns 0 if successful and -1 if it fails.
name_lenThe size of name needed to hold the filename. (OUT)

See C API: H5Pget_virtual_filename()

◆ h5pget_virtual_printf_gap_f()

subroutine h5pget_virtual_printf_gap_f ( integer(hid_t), intent(in)  dapl_id,
integer(hsize_t), intent(out)  gap_size,
integer, intent(out)  hdferr 
)

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.

Parameters
dapl_idDataset access property list identifier for the virtual dataset.
gap_sizeMaximum Number of the files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_virtual_printf_gap()

◆ h5pget_virtual_srcspace_f()

subroutine h5pget_virtual_srcspace_f ( integer(hid_t), intent(in)  dcpl_id,
integer(size_t), intent(in)  index,
integer(hid_t), intent(out)  ds_id,
integer, intent(out)  hdferr 
)

Gets a dataspace identifier for the selection within the source dataset used in the mapping.

Parameters
dcpl_idThe Identifier of the virtual dataset creation property list.
indexMapping index.The value of index is 0 (zero) or greater and less than count (0 ≤ index < count), where count is the number of mappings returned by h5pget_virtual_count.
ds_idDataspace identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_virtual_srcspace()

◆ h5pget_virtual_view_f()

subroutine h5pget_virtual_view_f ( integer(hid_t), intent(in)  dapl_id,
integer, intent(inout)  view,
integer, intent(out)  hdferr 
)

Retrieves the view of a virtual dataset accessed with dapl_id.

Parameters
dapl_idDataset access property list identifier for the virtual dataset.
viewThe flag specifying the view of the virtual dataset. Valid values are:
  • H5D_VDS_FIRST_MISSING_F
  • H5D_VDS_LAST_AVAILABLE_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_virtual_view()

◆ h5pget_virtual_vspace_f()

subroutine h5pget_virtual_vspace_f ( integer(hid_t), intent(in)  dcpl_id,
integer(size_t), intent(in)  index,
integer(hid_t), intent(out)  ds_id,
integer, intent(out)  hdferr 
)

Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.

Parameters
dcpl_idThe identifier of the virtual dataset creation property list.
indexMapping index. The value of index is 0 (zero) or greater and less than count (0 ≤ index < count), where count is the number of mappings returned by h5pget_virtual_count.
ds_idValid dataspace identifier identifier if successful; otherwise returns H5I_INVALID_HID_F.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pget_virtual_vspace()

◆ h5pget_vol_cap_flags_f()

subroutine h5pget_vol_cap_flags_f ( integer(hid_t), intent(in)  plist_id,
integer(c_int64_t), intent(out)  cap_flags,
integer, intent(out)  hdferr 
)

Query the capability flags for the VOL connector that will be used with this file access property list (FAPL).

◆ h5pget_vol_id_f()

subroutine h5pget_vol_id_f ( integer(hid_t), intent(in)  plist_id,
integer(hid_t), intent(out)  vol_id,
integer, intent(out)  hdferr 
)

Get the file VOL connector (VOL_ID) for a file access property list (PLIST_ID)

◆ h5pinsert_f() [1/2]

subroutine h5pinsert_f ( integer(hid_t), intent(in)  plist,
character(len=*), intent(in)  name,
integer(size_t), intent(in)  size,
type(c_ptr), intent(in)  value,
integer, intent(out)  hdferr 
)

Registers a temporary property with a property list class.

Attention
The preferred API, Fortran 2003 version.
Parameters
plistProperty list class identifier.
nameName of property to insert.
sizeSize of the property value.
valuePointer to new value pointer for the property being modified.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pinsert2()

◆ h5pinsert_f() [2/2]

subroutine h5pinsert_f ( integer(hid_t), intent(in)  plist,
character(len=*), intent(in)  name,
integer(size_t), intent(in)  size,
type(type), intent(in)  value,
integer, intent(out)  hdferr 
)

Registers a temporary property with a property list class.

Attention
Obsolete API, use the Fortran 2003 version instead.
Parameters
plistProperty list class identifier.
nameName of property to insert.
sizeSize of the property value.
valueProperty value, supported types are:
  • INTEGER
  • REAL
  • DOUBLE PRECISION
  • CHARACTER(LEN=*)
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pinsert2()

◆ h5pisa_class_f()

subroutine h5pisa_class_f ( integer(hid_t), intent(in)  plist,
integer(hid_t), intent(in)  pclass,
logical, intent(out)  flag,
integer, intent(out)  hdferr 
)

Determines whether a property list is a member of a class.

Parameters
plistProperty list identifier.
pclassIdentifier of the property class.
flagTRUE. if a member, .FALSE. otherwise.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pisa_class()

◆ h5pmodify_filter_f()

subroutine h5pmodify_filter_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  filter,
integer, intent(in)  flags,
integer(size_t), intent(in)  cd_nelmts,
integer, dimension(*), intent(in)  cd_values,
integer, intent(out)  hdferr 
)

Adds a filter to the filter pipeline.

Parameters
prp_idData creation or transfer property list identifier
filterFilter to be modified.
flagsBit vector specifying certain general properties of the filter
cd_nelmtsNumber of elements in cd_values.
cd_valuesAuxiliary data for the filter.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pmodify_filter()

◆ h5pregister_f() [1/2]

subroutine h5pregister_f ( integer(hid_t), intent(in)  class,
character(len=*), intent(in)  name,
integer(size_t), intent(in)  size,
type(c_ptr), intent(in)  value,
integer, intent(out)  hdferr 
)

Registers a permanent property with a property list class.

Attention
The preferred API, Fortran 2003 version.
Parameters
classProperty list class identifier.
nameName of property to register.
sizeSize of the property value.
valuePointer to value to set the property to.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pregister2()

◆ h5pregister_f() [2/2]

subroutine h5pregister_f ( integer(hid_t), intent(in)  class,
character(len=*), intent(in)  name,
integer(size_t), intent(in)  size,
type(type), intent(in)  value,
integer, intent(out)  hdferr 
)

Registers a permanent property with a property list class.

Attention
Obsolete API, use the Fortran 2003 version instead.
Parameters
classProperty list class identifier.
nameName of property to register.
sizeSize of the property value.
valueProperty value, supported types are:
  • INTEGER
  • REAL
  • DOUBLE PRECISION
  • CHARACTER(LEN=*)
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pregister2()

◆ h5premove_f()

subroutine h5premove_f ( integer(hid_t), intent(in)  plid,
character(len=*), intent(in)  name,
integer, intent(out)  hdferr 
)

Removes a property from a property list.

Parameters
plidProperty list identofoer.
nameName of the property to remove.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Premove()

◆ h5premove_filter_f()

subroutine h5premove_filter_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  filter,
integer, intent(out)  hdferr 
)

Delete one or more filters from the filter pipeline.

Parameters
prp_idData creation or transfer property list identifier
filterFilter to be removed.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Premove_filter()

◆ h5pset_alignment_f()

subroutine h5pset_alignment_f ( integer(hid_t), intent(in)  prp_id,
integer(hsize_t), intent(in)  threshold,
integer(hsize_t), intent(in)  alignment,
integer, intent(out)  hdferr 
)

Sets alignment properties of a file access property list.

Parameters
prp_idFile access property list identifier.
thresholdThreshold value.
alignmentAlignment value.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_alignment()

◆ h5pset_all_coll_metadata_ops_f()

subroutine h5pset_all_coll_metadata_ops_f ( integer(hid_t), intent(in)  plist_id,
logical, intent(in)  is_collective,
integer, intent(out)  hdferr 
)

Sets requirement whether HDF5 metadata read operations using the access property list are required to be collective or independent. If collective requirement is selected, the HDF5 library will optimize the metadata reads improving performance. The default setting is independent (false).

Parameters
plist_idFile access property list identifier.
is_collectiveIndicates if metadata writes are collective or not.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_all_coll_metadata_ops()

◆ h5pset_alloc_time_f()

subroutine h5pset_alloc_time_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(in)  flag,
integer, intent(out)  hdferr 
)

Set space allocation time for dataset during creation.

Parameters
plist_idDataset creation property list identifier.
flagAllocation time flag: Possible values are:
  • H5D_ALLOC_TIME_ERROR_F
  • H5D_ALLOC_TIME_DEFAULT_F
  • H5D_ALLOC_TIME_EARLY_F
  • H5D_ALLOC_TIME_LATE_F
  • H5D_ALLOC_TIME_INCR_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_alloc_time()

◆ h5pset_attr_creation_order_f()

subroutine h5pset_attr_creation_order_f ( integer(hid_t), intent(in)  ocpl_id,
integer, intent(in)  crt_order_flags,
integer, intent(out)  hdferr 
)

Sets tracking and indexing of attribute creation order.

Parameters
ocpl_idObject creation property list identifier.
crt_order_flagsFlags specifying whether to track and index attribute creation order.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_attr_creation_order()

◆ h5pset_attr_phase_change_f()

subroutine h5pset_attr_phase_change_f ( integer(hid_t), intent(in)  ocpl_id,
integer, intent(in)  max_compact,
integer, intent(in)  min_dense,
integer, intent(out)  hdferr 
)

Sets attribute storage phase change thresholds.

Parameters
ocpl_idObject (dataset or group) creation property list identifier.
max_compactMaximum number of attributes to be stored in compact storage, (Default: 8).
min_denseMinimum number of attributes to be stored in dense storage, (Default: 6).
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_attr_phase_change()

◆ h5pset_btree_ratios_f()

subroutine h5pset_btree_ratios_f ( integer(hid_t), intent(in)  prp_id,
real, intent(in)  left,
real, intent(in)  middle,
real, intent(in)  right,
integer, intent(out)  hdferr 
)

Sets B-tree split ratios for a dataset transfer property list.

Parameters
prp_idThe dataset transfer property list identifier.
leftThe B-tree split ratio for left-most nodes.
middleThe B-tree split ratio for all other nodes.
rightThe B-tree split ratio for right-most nodes.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_btree_ratios()

◆ h5pset_buffer_f()

subroutine h5pset_buffer_f ( integer(hid_t), intent(in)  plist_id,
integer(hsize_t), intent(in)  size,
integer, intent(out)  hdferr 
)

Sets sixe for conversion buffer.

Parameters
plist_idData transfer property list identifier.
sizeBuffer size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_buffer()

◆ h5pset_cache_f()

subroutine h5pset_cache_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  mdc_nelmts,
integer(size_t), intent(in)  rdcc_nelmts,
integer(size_t), intent(in)  rdcc_nbytes,
real, intent(in)  rdcc_w0,
integer, intent(out)  hdferr 
)

Sets the meta data cache and raw data chunk cache parameters.

Parameters
prp_idFile access property list identifier.
mdc_nelmtsNumber of elements (objects) in the metadata cache.
rdcc_nelmtsNumber of elements (objects) in the raw data chunk cache.
rdcc_nbytesTotal size of the raw data chunk cache, in bytes.
rdcc_w0Preemption policy (0 or 1).
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_cache()

◆ h5pset_char_encoding_f()

subroutine h5pset_char_encoding_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(in)  encoding,
integer, intent(out)  hdferr 
)

Sets the character encoding used to encode a string.

Parameters
plist_idProperty list identifier.
encodingValid values for encoding are:
  • H5T_CSET_ASCII_F -> US ASCII
  • H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_char_encoding()

◆ h5pset_chunk_cache_f()

subroutine h5pset_chunk_cache_f ( integer(hid_t), intent(in)  dapl_id,
integer(size_t), intent(in)  rdcc_nslots,
integer(size_t), intent(in)  rdcc_nbytes,
real, intent(in)  rdcc_w0,
integer, intent(out)  hdferr 
)

Set the number of objects in the meta data cache and the maximum number of chunks and bytes in the raw data chunk cache. Once set, these values will override the values in the file access property list. Each of these values can be individually unset (or not set at all) by passing the macros: H5D_CHUNK_CACHE_NSLOTS_DFLT_F, H5D_CHUNK_CACHE_NBYTES_DFLT_F, and/or H5D_CHUNK_CACHE_W0_DFLT_F as appropriate.

The RDCC_W0 value should be between 0 and 1 inclusive and indicates how much chunks that have been fully read or fully written are favored for preemption. A value of zero means fully read or written chunks are treated no differently than other chunks (the preemption is strictly LRU) while a value of one means fully read chunks are always preempted before other chunks.

Parameters
dapl_idDataset access property list identifier.
rdcc_nslotsThe number of chunk slots in the raw data chunk cache for this dataset.
rdcc_nbytesThe total size of the raw data chunk cache for this dataset.
rdcc_w0The chunk preemption policy for this dataset.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_chunk_cache()

◆ h5pset_chunk_f()

subroutine h5pset_chunk_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  ndims,
integer(hsize_t), dimension(ndims), intent(in)  dims,
integer, intent(out)  hdferr 
)

Sets the size of the chunks used to store a chunked layout dataset.

Parameters
prp_idDataset creation property list identifier.
ndimsNumber of dimensions for each chunk.
dimsArray with dimension sizes for each chunk.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_chunk()

◆ h5pset_coll_metadata_write_f()

subroutine h5pset_coll_metadata_write_f ( integer(hid_t), intent(in)  plist_id,
logical, intent(in)  is_collective,
integer, intent(out)  hdferr 
)

Sets metadata writes to collective or independent. Default setting is independent (false).

Parameters
plist_idFile access property list identifier.
is_collectiveIndicates if metadata writes are collective or not.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_coll_metadata_write()

◆ h5pset_copy_object_f()

subroutine h5pset_copy_object_f ( integer(hid_t), intent(in)  ocp_plist_id,
integer, intent(in)  copy_options,
integer, intent(out)  hdferr 
)

Sets properties to be used when an object is copied.

Parameters
ocp_plist_idObject copy property list identifier.
copy_optionsCopy option(s) to be set.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_copy_object()

◆ h5pset_create_inter_group_f()

subroutine h5pset_create_inter_group_f ( integer(hid_t), intent(in)  lcpl_id,
integer, intent(in)  crt_intermed_group,
integer, intent(out)  hdferr 
)

Specifies in property list whether to create missing intermediate groups.

Parameters
lcpl_idLink creation property list identifier.
crt_intermed_groupSpecifies whether to create intermediate groups upon the creation of an object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_create_intermediate_group()

◆ h5pset_data_transform_f()

subroutine h5pset_data_transform_f ( integer(hid_t), intent(in)  plist_id,
character(len=*), intent(in)  expression,
integer, intent(out)  hdferr 
)

Sets a data transform expression.

Parameters
plist_idIdentifier of the property list or class.
expressionBuffer to hold transform expression.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_data_transform()

◆ h5pset_deflate_f()

subroutine h5pset_deflate_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  level,
integer, intent(out)  hdferr 
)

Sets compression method and compression level.

Parameters
prp_idProperty list identifier.
levelCompression level.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_deflate()

◆ h5pset_dset_no_attrs_hint_f()

subroutine h5pset_dset_no_attrs_hint_f ( integer(hid_t), intent(in)  dcpl_id,
logical, intent(in)  minimize,
integer, intent(out)  hdferr 
)

Sets the value of the "minimize dataset headers" value which creates smaller dataset object headers when its set and no attributes are present.

Parameters
dcpl_idTarget dataset creation property list identifier.
minimizeValue of the setting.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_dset_no_attrs_hint()

◆ h5pset_dxpl_mpio_f()

subroutine h5pset_dxpl_mpio_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  data_xfer_mode,
integer, intent(out)  hdferr 
)

Sets data transfer mode.

Parameters
prp_idData transfer property list identifier.
data_xfer_modeTransfer mode; possible values are:
  • H5FD_MPIO_INDEPENDENT_F
  • H5FD_MPIO_COLLECTIVE_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_dxpl_mpio()

◆ h5pset_edc_check_f()

subroutine h5pset_edc_check_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  flag,
integer, intent(out)  hdferr 
)

Enables/disables error detecting.

Parameters
prp_idDataset creation property list identifier.
flagEDC flag. Possible values:
  • H5Z_DISABLE_EDC_F
  • H5Z_ENABLE_EDC_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_edc_check()

◆ h5pset_est_link_info_f()

subroutine h5pset_est_link_info_f ( integer(hid_t), intent(in)  gcpl_id,
integer, intent(in)  est_num_entries,
integer, intent(in)  est_name_len,
integer, intent(out)  hdferr 
)

Sets estimated number of links and length of link names in a group.

Parameters
gcpl_idGroup creation property list identifier.
est_num_entriesEstimated number of links to be inserted into group.
est_name_lenEstimated average length of link names.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_est_link_info()

◆ h5pset_external_f()

subroutine h5pset_external_f ( integer(hid_t), intent(in)  prp_id,
character(len=*), intent(in)  name,
integer(off_t), intent(in)  offset,
integer(hsize_t), intent(in)  bytes,
integer, intent(out)  hdferr 
)

Adds an external file to the list of external files.

Parameters
prp_idDataset creation property list identifier.
nameName of external file.
offsetOffset in bytes from the beginning of the file to the location in the file where the data starts.
bytesSize of the external file data.
hdferrReturns 0 if successful and -1 if it fails.
Note
On Windows, off_t is typically a 32-bit signed long value, which limits the valid offset that can be set to 2 GiB.

See C API: H5Pset_external()

◆ h5pset_f() [1/2]

subroutine h5pset_f ( integer(hid_t), intent(in)  prp_id,
character(len=*), intent(in)  name,
type(c_ptr), intent(in)  value,
integer, intent(out)  hdferr 
)

Sets a property list value.

Attention
The preferred API, Fortran 2003 version.
Parameters
prp_idProperty list identifier to modify.
nameName of property to modify.
valuePointer to value to set the property to.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset()

◆ h5pset_f() [2/2]

subroutine h5pset_f ( integer(hid_t), intent(in)  prp_id,
character(len=*), intent(in)  name,
integer, intent(in)  value,
integer, intent(out)  hdferr 
)

Sets a property list value.

Attention
Obsolete API, use the Fortran 2003 version instead.
Parameters
prp_idProperty list identifier to modify.
nameName of property to modify.
valueProperty value, supported types are:
  • INTEGER
  • REAL
  • DOUBLE PRECISION
  • CHARACTER(LEN=*)
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset()

◆ h5pset_family_offset_f()

subroutine h5pset_family_offset_f ( integer(hid_t), intent(in)  prp_id,
integer(hsize_t), intent(in)  offset,
integer, intent(out)  hdferr 
)

Sets offset for family file driver.

Parameters
prp_idFile creation property list identifier.
offsetFile offset.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_family_offset()

◆ h5pset_fapl_core_f()

subroutine h5pset_fapl_core_f ( integer(hid_t), intent(in)  prp_id,
integer(size_t), intent(in)  increment,
logical, intent(in)  backing_store,
integer, intent(out)  hdferr 
)

Modifies the file access property list to use the H5FD_CORE driver.

Parameters
prp_idFile access property list identifier.
incrementSize, in bytes, of memory increments.
backing_storeBoolean flag indicating whether to write the file contents to disk when the file is closed.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fapl_core()

◆ h5pset_fapl_direct_f()

subroutine h5pset_fapl_direct_f ( integer(hid_t), intent(in)  fapl_id,
integer(size_t), intent(in)  alignment,
integer(size_t), intent(in)  block_size,
integer(size_t), intent(in)  cbuf_size,
integer, intent(out)  hdferr 
)

Sets up use of the direct I/O driver.

Parameters
fapl_idFile access property list identifier.
alignmentRequired memory alignment boundary.
block_sizeFile system block size.
cbuf_sizeCopy buffer size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fapl_direct()

◆ h5pset_fapl_family_f()

subroutine h5pset_fapl_family_f ( integer(hid_t), intent(in)  prp_id,
integer(hsize_t), intent(in)  memb_size,
integer(hid_t), intent(in)  memb_plist,
integer, intent(out)  hdferr 
)

Sets the file access property list to use the family driver.

Parameters
prp_idFile access property list identifier.
memb_sizeSize in bytes of each file member.
memb_plistIdentifier of the file access property list to be used for each family member
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fapl_family()

◆ h5pset_fapl_ioc_f()

subroutine h5pset_fapl_ioc_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  hdferr,
type(h5fd_ioc_config_t), optional, target  vfd_config 
)

Modifies the specified File Access Property List to use the H5FD_IOC driver.

Parameters
prp_idFile access property list identifier.
hdferrReturns 0 if successful and -1 if it fails.
vfd_configH5FD_IOC driver configuration derived type.

See C API: H5Pset_fapl_ioc()

◆ h5pset_fapl_mpio_f() [1/2]

subroutine h5pset_fapl_mpio_f ( integer(hid_t), intent(in)  prp_id,
integer(kind=mpi_integer_kind), intent(in)  comm,
integer(kind=mpi_integer_kind), intent(in)  info,
integer, intent(out)  hdferr 
)

Stores MPI IO communicator information to the file access property list.

Parameters
prp_idFile access property list identifier.
commMPI-2 communicator.
infoMPI-2 info object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fapl_mpio()

◆ h5pset_fapl_mpio_f() [2/2]

subroutine h5pset_fapl_mpio_f ( integer(hid_t), intent(in)  prp_id,
type(mpi_comm), intent(in)  comm,
type(mpi_info), intent(in)  info,
integer, intent(out)  hdferr 
)

Stores MPI IO communicator information to the file access property list.

Note
Supports MPI Fortran module mpi_f08
Parameters
prp_idFile access property list identifier.
commMPI-3 communicator.
infoMPI-3 info object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fapl_mpio()

◆ h5pset_fapl_sec2_f()

subroutine h5pset_fapl_sec2_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  hdferr 
)

Sets the sec2 driver.

Parameters
prp_idFile access property list identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fapl_sec2()

◆ h5pset_fapl_split_f()

subroutine h5pset_fapl_split_f ( integer(hid_t), intent(in)  prp_id,
character(len=*), intent(in)  meta_ext,
integer(hid_t), intent(in)  meta_plist,
character(len=*), intent(in)  raw_ext,
integer(hid_t), intent(in)  raw_plist,
integer, intent(out)  hdferr 
)

Emulates the old split file driver.

Parameters
prp_idFile access property list identifier.
meta_extName of the extension for the metafile filename.
meta_plistIdentifier of the meta file access property list.
raw_extName extension for the raw file filename.
raw_plistIdentifier of the raw file access property list.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fapl_split()

◆ h5pset_fapl_stdio_f()

subroutine h5pset_fapl_stdio_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  hdferr 
)

Sets the standard I/O driver.

Parameters
prp_idFile access property list identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fapl_stdio()

◆ h5pset_fapl_subfiling_f()

subroutine h5pset_fapl_subfiling_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  hdferr,
type(h5fd_subfiling_config_t), optional, target  vfd_config 
)

Modifies the specified File Access Property List to use the H5FD_SUBFILING driver.

Parameters
prp_idFile access property list identifier.
hdferrReturns 0 if successful and -1 if it fails.
vfd_configH5FD_SUBFILING driver configuration derived type.

See C API: H5Pset_fapl_subfiling()

◆ h5pset_fclose_degree_f()

subroutine h5pset_fclose_degree_f ( integer(hid_t), intent(in)  fapl_id,
integer, intent(in)  degree,
integer, intent(out)  hdferr 
)

Sets the degree for the file close behavior.

Parameters
fapl_idFile access property list identifier.
degreePossible values are:
  • H5F_CLOSE_DEFAULT_F
  • H5F_CLOSE_WEAK_F
  • H5F_CLOSE_SEMI_F
  • H5F_CLOSE_STRONG_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fclose_degree()

◆ h5pset_file_image_f()

subroutine h5pset_file_image_f ( integer(hid_t), intent(in)  fapl_id,
type(c_ptr), intent(in)  buf_ptr,
integer(size_t), intent(in)  buf_len,
integer, intent(out)  hdferr 
)

Sets an initial file image in a memory buffer.

Parameters
fapl_idFile access property list identifier.
buf_ptrPointer to the initial file image, or C_NULL_PTR if no initial file image is desired.
buf_lenSize of the supplied buffer, or 0 (zero) if no initial image is desired.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_file_image()

◆ h5pset_file_locking_f()

subroutine h5pset_file_locking_f ( integer(hid_t), intent(in)  fapl_id,
logical, intent(in)  use_file_locking,
logical, intent(in)  ignore_disabled_locks,
integer, intent(out)  hdferr 
)

Sets the file locking properties. File locking is mainly used to help enforce SWMR semantics.

Parameters
fapl_idTarget file access property list identifier.
use_file_lockingWhether or not to use file locks.
ignore_disabled_locksWhether or not to ignore file locks when locking is disabled on a file system.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_file_locking()

◆ h5pset_file_space_page_size_f()

subroutine h5pset_file_space_page_size_f ( integer(hid_t), intent(in)  prp_id,
integer(hsize_t), intent(in)  fsp_size,
integer, intent(out)  hdferr 
)

Sets the file space page size for a file creation property list.

Parameters
prp_idFile creation property list identifier
fsp_sizeFile space page size
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_file_space_page_size()

◆ h5pset_file_space_strategy_f()

subroutine h5pset_file_space_strategy_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(in)  strategy,
logical, intent(in)  persist,
integer(hsize_t), intent(in)  threshold,
integer, intent(out)  hdferr 
)

Sets the file space handling strategy and persisting free-space values for a file creation property list.

Parameters
plist_idFile creation property list identifier
strategyThe file space handling strategy to be used. See: H5F_fspace_strategy_t
persistIndicates whether free space should be persistent or not
thresholdThe smallest free-space section size that the free space manager will track
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_file_space_strategy()

◆ h5pset_fill_time_f()

subroutine h5pset_fill_time_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(in)  flag,
integer, intent(out)  hdferr 
)

Set fill value writing time for dataset.

Parameters
plist_idDataset creation property list identifier.
flagFill time flag: Possible values are:
  • H5D_FILL_TIME_ERROR_F
  • H5D_FILL_TIME_ALLOC_F
  • H5D_FILL_TIME_NEVER_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fill_time()

◆ h5pset_fill_value_f() [1/2]

subroutine h5pset_fill_value_f ( integer(hid_t), intent(in)  prp_id,
integer(hid_t), intent(in)  type_id,
type(c_ptr), intent(in)  fillvalue,
integer, intent(out)  hdferr 
)

Sets fill value for a dataset creation property list.

Attention
The preferred API, Fortran 2003 version.
Parameters
prp_idProperty list identifier.
type_idDatatype identifier of fill value datatype (in memory).
fillvalueFillvalue.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fill_value()

◆ h5pset_fill_value_f() [2/2]

subroutine h5pset_fill_value_f ( integer(hid_t), intent(in)  prp_id,
integer(hid_t), intent(in)  type_id,
type(type), intent(in)  fillvalue,
integer, intent(out)  hdferr 
)

Sets fill value for a dataset creation property list.

Attention
Obsolete API, use the Fortran 2003 version instead.
Parameters
prp_idProperty list identifier.
type_idDatatype identifier of fill value datatype (in memory).
fillvalueFillvalue.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fill_value()

◆ h5pset_filter_f()

subroutine h5pset_filter_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  filter,
integer, intent(in)  flags,
integer(size_t), intent(in)  cd_nelmts,
integer, dimension(*), intent(in)  cd_values,
integer, intent(out)  hdferr 
)

Adds a filter to the filter pipeline.

Parameters
prp_idData creation or transfer property list identifier.
filterFilter to be added to the pipeline.
flagsBit vector specifying certain general properties of the filter.
cd_nelmtsNumber of elements in cd_values.
cd_valuesAuxiliary data for the filter.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_filter()

◆ h5pset_fletcher32_f()

subroutine h5pset_fletcher32_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  hdferr 
)

Sets Fletcher32 checksum of EDC for a dataset creation property list.

Parameters
prp_idDataset creation property list identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_fletcher32()

◆ h5pset_gc_references_f()

subroutine h5pset_gc_references_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  gc_reference,
integer, intent(out)  hdferr 
)

Sets garbage collecting references flag.

Parameters
prp_idFile access property list identifier.
gc_referenceFlag for setting garbage collection on and off (1 or 0).
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_gc_references()

◆ h5pset_hyper_vector_size_f()

subroutine h5pset_hyper_vector_size_f ( integer(hid_t), intent(in)  plist_id,
integer(size_t), intent(in)  size,
integer, intent(out)  hdferr 
)

Set the number of "I/O" vectors (vector size)

Parameters
plist_idDataset transfer property list identifier.
sizeVector size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_hyper_vector_size()

◆ h5pset_istore_k_f()

subroutine h5pset_istore_k_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  ik,
integer, intent(out)  hdferr 
)

Sets the size of the parameter used to control the B-trees for indexing chunked datasets.

Parameters
prp_idFile creation property list identifier
ik1/2 rank of chunked storage B-tree
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_istore_k()

◆ h5pset_layout_f()

subroutine h5pset_layout_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  layout,
integer, intent(out)  hdferr 
)

Sets the type of storage used store the raw data for a dataset.

Parameters
prp_idData creation property list identifier.
layoutType of storage layout for raw data. Possible values are:
  • H5D_COMPACT_F
  • H5D_CONTIGUOUS_F
  • H5D_CHUNKED_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_layout()

◆ h5pset_libver_bounds_f()

subroutine h5pset_libver_bounds_f ( integer(hid_t), intent(in)  fapl_id,
integer, intent(in)  low,
integer, intent(in)  high,
integer, intent(out)  hdferr 
)

Sets bounds on library versions, and indirectly format versions, to be used when creating objects.

Parameters
fapl_idFile access property list identifier.
lowThe earliest version of the library that will be used for writing objects.
highThe latest version of the library that will be used for writing objects.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_libver_bounds()

◆ h5pset_link_creation_order_f()

subroutine h5pset_link_creation_order_f ( integer(hid_t), intent(in)  gcpl_id,
integer, intent(in)  crt_order_flags,
integer, intent(out)  hdferr 
)

Sets creation order tracking and indexing for links in a group.

Parameters
gcpl_idGroup creation property list identifier.
crt_order_flagsCreation order flag(s).
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_link_creation_order()

◆ h5pset_link_phase_change_f()

subroutine h5pset_link_phase_change_f ( integer(hid_t), intent(in)  gcpl_id,
integer, intent(in)  max_compact,
integer, intent(in)  min_dense,
integer, intent(out)  hdferr 
)

Sets the parameters for conversion between compact and dense groups.

Parameters
gcpl_idGroup creation property list identifier.
max_compactMaximum number of attributes to be stored in compact storage.
min_denseMinimum number of attributes to be stored in dense storage.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_link_phase_change()

◆ h5pset_local_heap_size_hint_f()

subroutine h5pset_local_heap_size_hint_f ( integer(hid_t), intent(in)  gcpl_id,
integer(size_t), intent(in)  size_hint,
integer, intent(out)  hdferr 
)

Sets the local heap size hint for original-style groups.

Parameters
gcpl_idGroup creation property list identifier.
size_hintHint for size of local heap.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_local_heap_size_hint()

◆ h5pset_meta_block_size_f()

subroutine h5pset_meta_block_size_f ( integer(hid_t), intent(in)  plist_id,
integer(hsize_t), intent(in)  size,
integer, intent(out)  hdferr 
)

Sets the minimum size of metadata block allocations.

Parameters
plist_idFile access property list identifier.
sizeMetadata block size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_meta_block_size()

◆ h5pset_modify_write_buf_f()

subroutine h5pset_modify_write_buf_f ( integer(hid_t), intent(in)  plist_id,
logical, intent(in)  modify_write_buf,
integer, intent(out)  hdferr 
)

Allows the library to modify the contents of the write buffer.

Parameters
plist_idProperty list identifier
modify_write_bufWhether the library can modify the contents of the write buffer
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_modify_write_buf()

◆ h5pset_mpi_params_f() [1/2]

subroutine h5pset_mpi_params_f ( integer(hid_t), intent(in)  prp_id,
integer(kind=mpi_integer_kind), intent(in)  comm,
integer(kind=mpi_integer_kind), intent(in)  info,
integer, intent(out)  hdferr 
)

Set the MPI communicator and information.

Parameters
prp_idFile access property list identifier.
commMPI-2 communicator.
infoMPI-2 info object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_mpi_params()

◆ h5pset_mpi_params_f() [2/2]

subroutine h5pset_mpi_params_f ( integer(hid_t), intent(in)  prp_id,
type(mpi_comm), intent(in)  comm,
type(mpi_info), intent(in)  info,
integer, intent(out)  hdferr 
)

Set the MPI communicator and information.

Note
Supports MPI Fortran module mpi_f08
Parameters
prp_idFile access property list identifier.
commMPI-3 communicator.
infoMPI-3 info object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_mpi_params()

◆ h5pset_nbit_f()

subroutine h5pset_nbit_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(out)  hdferr 
)

Sets up the use of the N-Bit filter.

Parameters
plist_idDataset creation property list identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_nbit()

◆ h5pset_nlinks_f()

subroutine h5pset_nlinks_f ( integer(hid_t), intent(in)  lapl_id,
integer(size_t), intent(in)  nlinks,
integer, intent(out)  hdferr 
)

Sets maximum number of soft or user-defined link traversals.

Parameters
lapl_idFile access property list identifier.
nlinksMaximum number of links to traverse.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_nlinks()

◆ h5pset_obj_track_times_f()

subroutine h5pset_obj_track_times_f ( integer(hid_t), intent(in)  plist_id,
logical, intent(in)  flag,
integer, intent(out)  hdferr 
)

Set whether the birth, access, modification & change times for an object are stored.

Parameters
plist_idProperty list id.
flagObject timestamp setting, .TRUE. or .FALSE.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_obj_track_times()

◆ h5pset_preserve_f()

subroutine h5pset_preserve_f ( integer(hid_t), intent(in)  prp_id,
logical, intent(in)  flag,
integer, intent(out)  hdferr 
)

Sets the dataset transfer property list status to TRUE or FALSE for initializing compound datatype members during write/read operations.

Parameters
prp_idProperty list identifier.
flagStatus flag.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_preserve()

◆ h5pset_scaleoffset_f()

subroutine h5pset_scaleoffset_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(in)  scale_type,
integer, intent(in)  scale_factor,
integer, intent(out)  hdferr 
)

Sets up the use of the scale-offset filter.

Parameters
plist_idDataset creation property list identifier.
scale_typeFlag indicating compression method. Valid values:
  • H5Z_SO_FLOAT_DSCALE_F
  • H5Z_SO_FLOAT_ESCALE_F
  • H5Z_SO_INT_F
scale_factorParameter related to scale.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_scaleoffset()

◆ h5pset_selection_io_f()

subroutine h5pset_selection_io_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(in)  selection_io_mode,
integer, intent(out)  hdferr 
)

Sets the selection I/O mode.

Parameters
plist_idProperty list identifier
selection_io_modeThe selection I/O mode
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_selection_io()

◆ h5pset_shared_mesg_index_f()

subroutine h5pset_shared_mesg_index_f ( integer(hid_t), intent(in)  fcpl_id,
integer, intent(in)  index_num,
integer, intent(in)  mesg_type_flags,
integer, intent(in)  min_mesg_size,
integer, intent(out)  hdferr 
)

Configures the specified shared object header message index.

Parameters
fcpl_idFile creation property list identifier.
index_numIndex being configured.
mesg_type_flagsTypes of messages that should be stored in this index.
min_mesg_sizeMinimum message size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_shared_mesg_index()

◆ h5pset_shared_mesg_nindexes_f()

subroutine h5pset_shared_mesg_nindexes_f ( integer(hid_t), intent(in)  plist_id,
integer, intent(in)  nindexes,
integer, intent(out)  hdferr 
)

Sets number of shared object header message indexes.

Parameters
plist_idFile creation property list.
nindexesNumber of shared object header message indexes to be available in files created with this property list.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_shared_mesg_nindexes()

◆ h5pset_shuffle_f()

subroutine h5pset_shuffle_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(out)  hdferr 
)

Sets shuffling filter.

Parameters
prp_idDataset creation property list identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_shuffle()

◆ h5pset_sieve_buf_size_f()

subroutine h5pset_sieve_buf_size_f ( integer(hid_t), intent(in)  plist_id,
integer(size_t), intent(in)  size,
integer, intent(out)  hdferr 
)

Sets the maximum size of the data sieve buffer.

Parameters
plist_idFile access property list identifier.
sizeSieve buffer size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_sieve_buf_size()

◆ h5pset_sizes_f()

subroutine h5pset_sizes_f ( integer(hid_t), intent(in)  prp_id,
integer(size_t), intent(in)  sizeof_addr,
integer(size_t), intent(in)  sizeof_size,
integer, intent(out)  hdferr 
)

Sets the byte size of the offsets and lengths used to address objects in an HDF5 file.

Parameters
prp_idFile creation property list identifier.
sizeof_addrSize of an object offset in bytes.
sizeof_sizeSize of an object length in bytes.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_sizes()

◆ h5pset_small_data_block_size_f()

subroutine h5pset_small_data_block_size_f ( integer(hid_t), intent(in)  plist_id,
integer(hsize_t), intent(in)  size,
integer, intent(out)  hdferr 
)

Sets the minimum size of "small" raw data block.

Parameters
plist_idFile access property list identifier.
sizeSmall raw data block size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_small_data_block_size()

◆ h5pset_sym_k_f()

subroutine h5pset_sym_k_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  ik,
integer, intent(in)  lk,
integer, intent(out)  hdferr 
)

Sets the size of parameters used to control the symbol table nodes.

Parameters
prp_idFile creation property list identifier.
ikSymbol table tree rank.
lkSymbol table node size.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_sym_k()

◆ h5pset_szip_f()

subroutine h5pset_szip_f ( integer(hid_t), intent(in)  prp_id,
integer, intent(in)  options_mask,
integer, intent(in)  pixels_per_block,
integer, intent(out)  hdferr 
)

Sets up use of szip compression.

Parameters
prp_idDataset creation property list identifier.
options_maskA bit-mask conveying the desired SZIP options. Current valid values in Fortran are:
  • H5_SZIP_EC_OM_F
  • H5_SZIP_NN_OM_F
pixels_per_blockSzip parameters.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_szip()

◆ h5pset_userblock_f()

subroutine h5pset_userblock_f ( integer(hid_t), intent(in)  prp_id,
integer(hsize_t), intent(in)  size,
integer, intent(out)  hdferr 
)

Sets user block size.

Parameters
prp_idFile creation property list to modify.
sizeSize of the user-block in bytes.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_userblock()

◆ h5pset_virtual_f()

subroutine h5pset_virtual_f ( integer(hid_t), intent(in)  dcpl_id,
integer(hid_t), intent(in)  vspace_id,
character(len=*), intent(in)  src_file_name,
character(len=*), intent(in)  src_dset_name,
integer(hid_t), intent(in)  src_space_id,
integer, intent(out)  hdferr 
)

Sets the mapping between virtual and source datasets.

Parameters
dcpl_idThe identifier of the dataset creation property list that will be used when creating the virtual dataset.
vspace_idThe dataspace identifier with the selection within the virtual dataset applied, possibly an unlimited selection.
src_file_nameThe name of the HDF5 file where the source dataset is located.
src_dset_nameThe path to the HDF5 dataset in the file specified by src_file_name.
src_space_idThe source dataset's dataspace identifier with a selection applied, possibly an unlimited selection.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_virtual()

◆ h5pset_virtual_printf_gap_f()

subroutine h5pset_virtual_printf_gap_f ( integer(hid_t), intent(in)  dapl_id,
integer(hsize_t), intent(in)  gap_size,
integer, intent(out)  hdferr 
)

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.

Parameters
dapl_idDataset access property list identifier for the virtual dataset.
gap_sizeMaximum number of files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_virtual_printf_gap()

◆ h5pset_virtual_view_f()

subroutine h5pset_virtual_view_f ( integer(hid_t), intent(in)  dapl_id,
integer, intent(in)  view,
integer, intent(out)  hdferr 
)

Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements.

Parameters
dapl_idIdentifier Of the virtual dataset access property list.
viewFlag specifying the extent of the data to be included in the view. Valid values are:
  • H5D_VDS_FIRST_MISSING_F
  • H5D_VDS_LAST_AVAILABLE_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Pset_virtual_view()

◆ h5pset_vol_f()

subroutine h5pset_vol_f ( integer(hid_t), intent(in)  plist_id,
integer(hid_t), intent(in)  new_vol_id,
integer, intent(out)  hdferr,
type(c_ptr), intent(in), optional  new_vol_info 
)

Set the file VOL connector (VOL_ID) for a file access property list (PLIST_ID)

Parameters
plist_idAccess property list identifier.
new_vol_idVOL connector id.
hdferrReturns 0 if successful and -1 if it fails.
new_vol_infoVOL connector info.

See C API: H5Pset_vol()

◆ h5punregister_f()

subroutine h5punregister_f ( integer(hid_t), intent(in)  class,
character(len=*), intent(in)  name,
integer, intent(out)  hdferr 
)

Removes a property from a property list class.

Parameters
classProperty list class identifier.
nameName of the property to remove.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Punregister()

Variable Documentation

◆ h5fd_core_f

integer(hid_t) h5fd_core_f

H5FD_CORE.

◆ h5fd_family_f

integer(hid_t) h5fd_family_f

H5FD_FAMILY.

◆ h5fd_ioc_curr_fapl_version_f

integer h5fd_ioc_curr_fapl_version_f

H5FD_IOC_CURR_FAPL_VERSION.

◆ h5fd_ioc_default_thread_pool_size_f

integer h5fd_ioc_default_thread_pool_size_f

H5FD_IOC_DEFAULT_THREAD_POOL_SIZE.

◆ h5fd_ioc_fapl_magic_f

integer h5fd_ioc_fapl_magic_f

H5FD_IOC_FAPL_MAGIC.

◆ h5fd_log_f

integer(hid_t) h5fd_log_f

H5FD_LOG.

◆ h5fd_mem_btree_f

integer h5fd_mem_btree_f

H5FD_MEM_BTREE.

◆ h5fd_mem_default_f

integer h5fd_mem_default_f

H5FD_MEM_DEFAULT.

◆ h5fd_mem_draw_f

integer h5fd_mem_draw_f

H5FD_MEM_DRAW.

◆ h5fd_mem_gheap_f

integer h5fd_mem_gheap_f

H5FD_MEM_GHEAP.

◆ h5fd_mem_lheap_f

integer h5fd_mem_lheap_f

H5FD_MEM_LHEAP.

◆ h5fd_mem_nolist_f

integer h5fd_mem_nolist_f

H5FD_MEM_NOLIST.

◆ h5fd_mem_ntypes_f

integer h5fd_mem_ntypes_f

H5FD_MEM_NTYPES.

◆ h5fd_mem_ohdr_f

integer h5fd_mem_ohdr_f

H5FD_MEM_OHDR.

◆ h5fd_mem_super_f

integer h5fd_mem_super_f

H5FD_MEM_SUPER.

◆ h5fd_mpio_collective_f

integer h5fd_mpio_collective_f

H5FD_MPIO_COLLECTIVE.

◆ h5fd_mpio_f

integer(hid_t) h5fd_mpio_f

H5FD_MPIO.

◆ h5fd_mpio_independent_f

integer h5fd_mpio_independent_f

H5FD_MPIO_INDEPENDENT.

◆ h5fd_multi_f

integer(hid_t) h5fd_multi_f

H5FD_MULTI.

◆ h5fd_sec2_f

integer(hid_t) h5fd_sec2_f

H5FD_SEC2.

◆ h5fd_stdio_f

integer(hid_t) h5fd_stdio_f

H5FD_STDIO.

◆ h5fd_subfiling_curr_fapl_version_f

integer h5fd_subfiling_curr_fapl_version_f

H5FD_SUBFILING_CURR_FAPL_VERSION.

◆ h5fd_subfiling_default_stripe_count_f

integer h5fd_subfiling_default_stripe_count_f

H5FD_SUBFILING_DEFAULT_STRIPE_COUNT.

◆ h5fd_subfiling_default_stripe_size_f

integer(hid_t) h5fd_subfiling_default_stripe_size_f

H5FD_SUBFILING_DEFAULT_STRIPE_SIZE.

◆ h5fd_subfiling_f

integer(hid_t) h5fd_subfiling_f

H5FD_SUBFILING.

◆ h5fd_subfiling_fapl_magic_f

integer h5fd_subfiling_fapl_magic_f

H5FD_SUBFILING_FAPL_MAGIC.

◆ h5p_attribute_create_f

integer(hid_t) h5p_attribute_create_f

H5P_ATTRIBUTE_CREATE.

◆ h5p_crt_order_indexed_f

integer h5p_crt_order_indexed_f

H5P_CRT_ORDER_INDEXED.

◆ h5p_crt_order_tracked_f

integer h5p_crt_order_tracked_f

H5P_CRT_ORDER_TRACKED.

◆ h5p_dataset_access_f

integer(hid_t) h5p_dataset_access_f

H5P_DATASET_ACCESS.

◆ h5p_dataset_create_f

integer(hid_t) h5p_dataset_create_f

H5P_DATASET_CREATE.

◆ h5p_dataset_xfer_f

integer(hid_t) h5p_dataset_xfer_f

H5P_DATASET_XFER.

◆ h5p_datatype_access_f

integer(hid_t) h5p_datatype_access_f

H5P_DATATYPE_ACCESS.

◆ h5p_datatype_create_f

integer(hid_t) h5p_datatype_create_f

H5P_DATATYPE_CREATE.

◆ h5p_default_f

integer(hid_t) h5p_default_f

H5P_DEFAULT.

◆ h5p_file_access_f

integer(hid_t) h5p_file_access_f

H5P_FILE_ACCESS.

◆ h5p_file_create_f

integer(hid_t) h5p_file_create_f

H5P_FILE_CREATE.

◆ h5p_file_mount_f

integer(hid_t) h5p_file_mount_f

H5P_FILE_MOUNT.

◆ h5p_group_access_f

integer(hid_t) h5p_group_access_f

H5P_GROUP_ACCESS.

◆ h5p_group_create_f

integer(hid_t) h5p_group_create_f

H5P_GROUP_CREATE.

◆ h5p_link_access_f

integer(hid_t) h5p_link_access_f

H5P_LINK_ACCESS.

◆ h5p_link_create_f

integer(hid_t) h5p_link_create_f

H5P_LINK_CREATE.

◆ h5p_object_copy_f

integer(hid_t) h5p_object_copy_f

H5P_OBJECT_COPY.

◆ h5p_object_create_f

integer(hid_t) h5p_object_create_f

H5P_OBJECT_CREATE.

◆ h5p_root_f

integer(hid_t) h5p_root_f

H5P_ROOT.

◆ h5p_string_create_f

integer(hid_t) h5p_string_create_f

H5P_STRING_CREATE.

◆ ioc_fapl_id

integer(hid_t) ioc_fapl_id

The FAPL setup with the stacked VFD to use for I/O concentrators.

◆ ioc_selection

integer(c_int) ioc_selection

Method to select I/O concentrators.

◆ ioc_selection_options_f

integer ioc_selection_options_f

Sentinel value, IOC_SELECTION_OPTIONS.

◆ magic [1/2]

integer(c_int32_t) magic

Set to H5FD_SUBFILING_FAPL_MAGIC_F.

◆ magic [2/2]

integer(c_int32_t) magic

Must be set to H5FD_IOC_FAPL_MAGIC_F.

◆ require_ioc

logical(c_bool) require_ioc

Whether to use the IOC VFD (currently must always be TRUE)

◆ select_ioc_every_nth_rank_f

integer select_ioc_every_nth_rank_f

Starting at rank 0, select-next += N, SELECT_IOC_EVERY_NTH_RANK.

◆ select_ioc_one_per_node_f

integer select_ioc_one_per_node_f

Default, SELECT_IOC_ONE_PER_NODE.

◆ select_ioc_total_f

integer select_ioc_total_f

Starting at rank 0, mpi_size / total, SELECT_IOC_TOTAL.

◆ select_ioc_with_config_f

integer select_ioc_with_config_f

NOT IMPLEMENTED: Read-from-file, SELECT_IOC_WITH_CONFIG.

◆ shared_cfg

type(h5fd_subfiling_params_t) shared_cfg

Subfiling/IOC parameters (stripe size, stripe count, etc.)

◆ stripe_count

integer(c_int32_t) stripe_count

Target number of subfiles to use.

◆ stripe_size

integer(c_int64_t) stripe_size

Size (in bytes) of data stripes in subfiles.

◆ thread_pool_size

integer(c_int32_t) thread_pool_size

Number of I/O concentrator worker threads to use.

◆ version [1/2]

integer(c_int32_t) version

Set to H5FD_CURR_SUBFILING_FAPL_VERSION_F.

◆ version [2/2]

integer(c_int32_t) version

Must be set to H5FD_IOC_CURR_FAPL_VERSION_F.