Help us improve by taking our short survey: https://www.hdfgroup.org/website-survey/

| HDF5 Last Updated on 2025-11-11 The HDF5 Field Guide

- Main Page
- Getting started
- User Guide
- Reference Manual
- Cookbook
- Technical Notes
- RFCs
- Specifications
- Glossary
- Full-Text Search
- About

Loading...
Searching...
No Matches
Functions
Java Property List (H5P) Interface

## Detailed Description

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

## Functions
static boolean | H5P_equal (long plid1, long plid2) throws HDF5LibraryException
static synchronized native boolean | H5Pall_filters_avail (long dcpl_id) throws HDF5LibraryException, NullPointerException
static int | H5Pclose (long plist) throws HDF5LibraryException
static int | H5Pclose_class (long plid) throws HDF5LibraryException
static long | H5Pcopy (long plist) throws HDF5LibraryException
static synchronized native int | H5Pcopy_prop (long dst_id, long src_id, String name) throws HDF5LibraryException
static long | H5Pcreate (long type) throws HDF5LibraryException
static long | H5Pcreate_class_nocb (long parent_class, String name) throws HDF5LibraryException
static synchronized native int | H5Pequal (long plid1, long plid2) throws HDF5LibraryException
static synchronized native boolean | H5Pexist (long plid, String name) throws HDF5LibraryException
static synchronized native int | H5Pfill_value_defined (long plist_id, int[] status) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget (long plid, String name) throws HDF5LibraryException
static synchronized native int | H5Pget_alignment (long plist, long[] alignment) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
static synchronized native int | H5Pget_alloc_time (long plist_id, int[] alloc_time) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_attr_creation_order (long ocpl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_attr_phase_change (long ocpl_id, int[] attributes) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_btree_ratios (long plist_id, double[] left, double[] middle, double[] right) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_buffer (long plist, byte[] tconv, byte[] bkg) throws HDF5LibraryException, IllegalArgumentException
static synchronized native long | H5Pget_buffer_size (long plist) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pget_cache (long plist, int[] mdc_nelmts, long[] rdcc_nelmts, long[] rdcc_nbytes, double[] rdcc_w0) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_char_encoding (long plist_id) throws HDF5LibraryException
static synchronized native int | H5Pget_chunk (long plist, int max_ndims, long[] dims) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
static synchronized native void | H5Pget_chunk_cache (long dapl_id, long[] rdcc_nslots, long[] rdcc_nbytes, double[] rdcc_w0) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_chunk_opts (long dcpl_id) throws HDF5LibraryException
static synchronized native long | H5Pget_class (long plist) throws HDF5LibraryException
static synchronized native String | H5Pget_class_name (long plid) throws HDF5LibraryException
static synchronized native long | H5Pget_class_parent (long plid) throws HDF5LibraryException
static synchronized native int | H5Pget_copy_object (long ocp_plist_id) throws HDF5LibraryException
static synchronized native boolean | H5Pget_create_intermediate_group (long lcpl_id) throws HDF5LibraryException
static synchronized native long | H5Pget_data_transform (long plist_id, String[] expression, long size) throws HDF5LibraryException, IllegalArgumentException
static synchronized native long | H5Pget_driver (long plid) throws HDF5LibraryException
static synchronized native boolean | H5Pget_dset_no_attrs_hint (long dcpl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_edc_check (long plist) throws HDF5LibraryException
static synchronized native String | H5Pget_efile_prefix (long dapl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_elink_acc_flags (long lapl_id) throws HDF5LibraryException
static long | H5Pget_elink_fapl (long lapl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_elink_file_cache_size (long fapl_id) throws HDF5LibraryException
static synchronized native long | H5Pget_elink_prefix (long lapl_id, String[] prefix) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_est_link_info (long gcpl_id, int[] link_info) throws HDF5LibraryException, NullPointerException
static synchronized native boolean | H5Pget_evict_on_close (long fapl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_external (long plist, int idx, long name_size, String[] name, long[] size) throws ArrayIndexOutOfBoundsException, ArrayStoreException, HDF5LibraryException, NullPointerException, IllegalArgumentException
static synchronized native int | H5Pget_external_count (long plist) throws HDF5LibraryException
static synchronized native long | H5Pget_family_offset (long fapl_id) throws HDF5LibraryException
static synchronized native void | H5Pget_fapl_core (long fapl_id, long[] increment, boolean[] backing_store) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_fapl_direct (long fapl_id, long[] info) throws HDF5LibraryException
static synchronized native int | H5Pget_fapl_family (long fapl_id, long[] memb_size, long[] memb_fapl_id) throws HDF5LibraryException, NullPointerException
static synchronized native H5FD_hdfs_fapl_t | H5Pget_fapl_hdfs (long fapl_id) throws HDF5LibraryException, NullPointerException
static synchronized native boolean | H5Pget_fapl_multi (long fapl_id, int[] memb_map, long[] memb_fapl, String[] memb_name, long[] memb_addr) throws HDF5LibraryException, NullPointerException
static synchronized native H5FD_ros3_fapl_t | H5Pget_fapl_ros3 (long fapl_id) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_fclose_degree (long fapl_id) throws HDF5LibraryException, NullPointerException
static synchronized native long | H5Pget_file_space_page_size (long fcpl_id) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pget_file_space_strategy (long fcpl_id, boolean[] persist, long[] threshold) throws HDF5LibraryException, IllegalArgumentException
static synchronized native boolean | H5Pget_file_space_strategy_persist (long fcpl_id) throws HDF5LibraryException, IllegalArgumentException
static synchronized native long | H5Pget_file_space_strategy_threshold (long fcpl_id) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pget_fill_time (long plist_id, int[] fill_time) throws HDF5LibraryException
static synchronized native int | H5Pget_fill_value (long plist_id, long type_id, byte[] value) throws HDF5Exception
static synchronized int | H5Pget_fill_value (long plist_id, long type_id, Object obj) throws HDF5Exception
static int | H5Pget_filter (long plist, int filter_number, int[] flags, long[] cd_nelmts, int[] cd_values, long namelen, String[] name, int[] filter_config) throws ArrayIndexOutOfBoundsException, ArrayStoreException, HDF5LibraryException, NullPointerException
static int | H5Pget_filter_by_id (long plist_id, long filter_id, int[] flags, long[] cd_nelmts, int[] cd_values, long namelen, String[] name, int[] filter_config) throws ArrayIndexOutOfBoundsException, ArrayStoreException, HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_filter_by_id2 (long plist_id, long filter_id, int[] flags, long[] cd_nelmts, int[] cd_values, long namelen, String[] name, int[] filter_config) throws HDF5LibraryException, NullPointerException
static synchronized native boolean | H5Pget_gc_references (long fapl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_hyper_vector_size (long dxpl_id, long[] vector_size) throws HDF5LibraryException, NullPointerException
static synchronized native boolean | H5Pget_ignore_disabled_file_locking (long fapl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_istore_k (long plist, int[] ik) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_layout (long plist) throws HDF5LibraryException
static synchronized native int | H5Pget_libver_bounds (long fapl_id, int[] libver) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pget_link_creation_order (long gcpl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_link_phase_change (long gcpl_id, int[] links) throws HDF5LibraryException, NullPointerException
static synchronized native long | H5Pget_local_heap_size_hint (long gcpl_id) throws HDF5LibraryException
static synchronized native H5AC_cache_config_t | H5Pget_mdc_config (long plist_id) throws HDF5LibraryException
static synchronized native String | H5Pget_mdc_log_options (long fapl_id, boolean[] mdc_log_options) throws HDF5LibraryException
static synchronized native long | H5Pget_meta_block_size (long fapl_id) throws HDF5LibraryException
static synchronized native long | H5Pget_metadata_read_attempts (long plist_id) throws HDF5LibraryException
static synchronized native int | H5Pget_nfilters (long plist) throws HDF5LibraryException
static synchronized native long | H5Pget_nlinks (long lapl_id) throws HDF5LibraryException
static synchronized native long | H5Pget_nprops (long plid) throws HDF5LibraryException
static synchronized native boolean | H5Pget_obj_track_times (long ocpl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_shared_mesg_index (long fcpl_id, int index_num, int[] mesg_info) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
static synchronized native int | H5Pget_shared_mesg_nindexes (long fcpl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_shared_mesg_phase_change (long fcpl_id, int[] size) throws HDF5LibraryException, NullPointerException
static synchronized native long | H5Pget_sieve_buf_size (long fapl_id) throws HDF5LibraryException
static synchronized native long | H5Pget_size (long plid, String name) throws HDF5LibraryException
static synchronized native int | H5Pget_sizes (long plist, long[] size) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
static synchronized native long | H5Pget_small_data_block_size (long plist) throws HDF5LibraryException
static synchronized native int | H5Pget_sym_k (long plist, int[] size) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
static synchronized native boolean | H5Pget_use_file_locking (long fapl_id) throws HDF5LibraryException
static synchronized native int | H5Pget_userblock (long plist, long[] size) throws HDF5LibraryException, NullPointerException
static synchronized native long | H5Pget_virtual_count (long dcpl_id) throws HDF5LibraryException, IllegalArgumentException
static synchronized native String | H5Pget_virtual_dsetname (long dcpl_id, long index) throws HDF5LibraryException, IllegalArgumentException
static synchronized native String | H5Pget_virtual_filename (long dcpl_id, long index) throws HDF5LibraryException, IllegalArgumentException
static synchronized native String | H5Pget_virtual_prefix (long dapl_id) throws HDF5LibraryException
static synchronized native long | H5Pget_virtual_printf_gap (long dapl_id) throws HDF5LibraryException
static synchronized native boolean | H5Pget_virtual_spatial_tree (long dapl_id) throws HDF5LibraryException
static synchronized native long | H5Pget_virtual_srcspace (long dcpl_id, long index) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pget_virtual_view (long dapl_id) throws HDF5LibraryException
static synchronized native long | H5Pget_virtual_vspace (long dcpl_id, long index) throws HDF5LibraryException, IllegalArgumentException
static synchronized native void | H5Pinsert2_nocb (long plist, String name, long size, byte[] value) throws HDF5LibraryException
static synchronized native int | H5Pisa_class (long plist, long pclass) throws HDF5LibraryException
static synchronized native int | H5Piterate (long plist, int[] idx, H5P_iterate_cb op, H5P_iterate_t op_data) throws HDF5LibraryException
static synchronized native int | H5Pmodify_filter (long plist, long filter, int flags, long cd_nelmts, int[] cd_values) throws HDF5LibraryException, NullPointerException
static synchronized native void | H5Pregister2_nocb (long plist_class, String name, long size, byte[] def_value) throws HDF5LibraryException
static synchronized native int | H5Premove (long plid, String name) throws HDF5LibraryException
static synchronized native int | H5Premove_filter (long obj_id, long filter) throws HDF5LibraryException
static synchronized native int | H5Pset (long plid, String name, int value) throws HDF5LibraryException
static synchronized native int | H5Pset_alignment (long plist, long threshold, long alignment) throws HDF5LibraryException
static synchronized native int | H5Pset_alloc_time (long plist_id, int alloc_time) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_attr_creation_order (long ocpl_id, int crt_order_flags) throws HDF5LibraryException
static synchronized native void | H5Pset_attr_phase_change (long ocpl_id, int max_compact, int min_dense) throws HDF5LibraryException
static synchronized native int | H5Pset_btree_ratios (long plist_id, double left, double middle, double right) throws HDF5LibraryException
static synchronized native void | H5Pset_buffer_size (long plist, long size) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pset_cache (long plist, int mdc_nelmts, long rdcc_nelmts, long rdcc_nbytes, double rdcc_w0) throws HDF5LibraryException
static synchronized native void | H5Pset_char_encoding (long plist_id, int encoding) throws HDF5LibraryException
static synchronized native int | H5Pset_chunk (long plist, int ndims, byte[] dim) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
static synchronized int | H5Pset_chunk (long plist, int ndims, long[] dim) throws HDF5Exception, NullPointerException, IllegalArgumentException
static synchronized native void | H5Pset_chunk_cache (long dapl_id, long rdcc_nslots, long rdcc_nbytes, double rdcc_w0) throws HDF5LibraryException
static synchronized native void | H5Pset_chunk_opts (long dcpl_id, int opts) throws HDF5LibraryException
static synchronized native void | H5Pset_copy_object (long ocp_plist_id, int copy_options) throws HDF5LibraryException
static synchronized native int | H5Pset_create_intermediate_group (long lcpl_id, boolean crt_intermed_group) throws HDF5LibraryException
static synchronized native int | H5Pset_data_transform (long plist_id, String expression) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_deflate (long plist, int level) throws HDF5LibraryException
static synchronized native void | H5Pset_dset_no_attrs_hint (long dcpl_id, boolean minimize) throws HDF5LibraryException
static synchronized native int | H5Pset_edc_check (long plist, int check) throws HDF5LibraryException
static synchronized native void | H5Pset_efile_prefix (long dapl_id, String prefix) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_elink_acc_flags (long lapl_id, int flags) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pset_elink_fapl (long lapl_id, long fapl_id) throws HDF5LibraryException
static synchronized native void | H5Pset_elink_file_cache_size (long fapl_id, int efc_size) throws HDF5LibraryException
static synchronized native int | H5Pset_elink_prefix (long lapl_id, String prefix) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_est_link_info (long gcpl_id, int est_num_entries, int est_name_len) throws HDF5LibraryException, IllegalArgumentException
static synchronized native void | H5Pset_evict_on_close (long fapl_id, boolean evict_on_close) throws HDF5LibraryException
static synchronized native int | H5Pset_external (long plist, String name, long offset, long size) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_family_offset (long fapl_id, long offset) throws HDF5LibraryException
static synchronized native int | H5Pset_fapl_core (long fapl_id, long increment, boolean backing_store) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_fapl_direct (long fapl_id, long alignment, long block_size, long cbuf_size) throws HDF5LibraryException
static synchronized native int | H5Pset_fapl_family (long fapl_id, long memb_size, long memb_fapl_id) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_fapl_hdfs (long fapl_id, H5FD_hdfs_fapl_t fapl_conf) throws HDF5LibraryException, NullPointerException
static synchronized native void | H5Pset_fapl_log (long fapl_id, String logfile, long flags, long buf_size) throws HDF5LibraryException, NullPointerException
static synchronized native void | H5Pset_fapl_multi (long fapl_id, int[] memb_map, long[] memb_fapl, String[] memb_name, long[] memb_addr, boolean relax) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_fapl_ros3 (long fapl_id, H5FD_ros3_fapl_t fapl_conf) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_fapl_sec2 (long fapl_id) throws HDF5LibraryException, NullPointerException
static synchronized native void | H5Pset_fapl_split (long fapl_id, String meta_ext, long meta_plist_id, String raw_ext, long raw_plist_id) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_fapl_stdio (long fapl_id) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_fapl_windows (long fapl_id) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_fclose_degree (long fapl_id, int degree) throws HDF5LibraryException, NullPointerException
static synchronized native void | H5Pset_file_locking (long fapl_id, boolean use_file_locking, boolean ignore_when_disabled) throws HDF5LibraryException
static synchronized native void | H5Pset_file_space_page_size (long fcpl_id, long page_size) throws HDF5LibraryException, IllegalArgumentException
static synchronized native void | H5Pset_file_space_strategy (long fcpl_id, int strategy, boolean persist, long threshold) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pset_fill_time (long plist_id, int fill_time) throws HDF5LibraryException
static synchronized native int | H5Pset_fill_value (long plist_id, long type_id, byte[] value) throws HDF5Exception
static synchronized int | H5Pset_fill_value (long plist_id, long type_id, Object obj) throws HDF5Exception
static synchronized native int | H5Pset_filter (long plist, int filter, int flags, long cd_nelmts, int[] cd_values) throws HDF5LibraryException
static synchronized native int | H5Pset_fletcher32 (long plist) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_gc_references (long fapl_id, boolean gc_ref) throws HDF5LibraryException
static synchronized native int | H5Pset_hyper_vector_size (long dxpl_id, long vector_size) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_istore_k (long plist, int ik) throws HDF5LibraryException
static synchronized native int | H5Pset_layout (long plist, int layout) throws HDF5LibraryException
static synchronized native int | H5Pset_libver_bounds (long fapl_id, int low, int high) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pset_link_creation_order (long gcpl_id, int crt_order_flags) throws HDF5LibraryException
static synchronized native int | H5Pset_link_phase_change (long gcpl_id, int max_compact, int min_dense) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pset_local_heap_size_hint (long gcpl_id, long size_hint) throws HDF5LibraryException
static synchronized native void | H5Pset_mdc_config (long plist_id, H5AC_cache_config_t config_ptr) throws HDF5LibraryException
static synchronized native void | H5Pset_mdc_log_options (long fapl_id, boolean is_enabled, String location, boolean start_on_access) throws HDF5LibraryException, NullPointerException
static synchronized native void | H5Pset_meta_block_size (long fapl_id, long size) throws HDF5LibraryException
static synchronized native void | H5Pset_metadata_read_attempts (long plist_id, long attempts) throws HDF5LibraryException
static synchronized native int | H5Pset_nbit (long plist_id) throws HDF5LibraryException
static synchronized native int | H5Pset_nlinks (long lapl_id, long nlinks) throws HDF5LibraryException, IllegalArgumentException
static synchronized native void | H5Pset_obj_track_times (long ocpl_id, boolean track_times) throws HDF5LibraryException
static synchronized native int | H5Pset_scaleoffset (long plist_id, int scale_type, int scale_factor) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pset_shared_mesg_index (long fcpl_id, int index_num, int mesg_type_flags, int min_mesg_size) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pset_shared_mesg_nindexes (long plist_id, int nindexes) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pset_shared_mesg_phase_change (long fcpl_id, int max_list, int min_btree) throws HDF5LibraryException, IllegalArgumentException
static synchronized native int | H5Pset_shuffle (long plist_id) throws HDF5LibraryException, NullPointerException
static synchronized native void | H5Pset_sieve_buf_size (long fapl_id, long size) throws HDF5LibraryException
static synchronized native int | H5Pset_sizes (long plist, int sizeof_addr, int sizeof_size) throws HDF5LibraryException
static synchronized native int | H5Pset_small_data_block_size (long plist, long size) throws HDF5LibraryException
static synchronized native int | H5Pset_sym_k (long plist, int ik, int lk) throws HDF5LibraryException
static synchronized native int | H5Pset_szip (long plist, int options_mask, int pixels_per_block) throws HDF5LibraryException, NullPointerException
static synchronized native int | H5Pset_userblock (long plist, long size) throws HDF5LibraryException
static synchronized native void | H5Pset_virtual (long dcpl_id, long vspace_id, String src_file_name, String src_dset_name, long src_space_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
static synchronized native void | H5Pset_virtual_prefix (long dapl_id, String prefix) throws HDF5LibraryException, NullPointerException
static synchronized native void | H5Pset_virtual_printf_gap (long dapl_id, long gap_size) throws HDF5LibraryException
static synchronized native void | H5Pset_virtual_spatial_tree (long dapl_id, boolean use_tree) throws HDF5LibraryException
static synchronized native void | H5Pset_virtual_view (long dapl_id, int view) throws HDF5LibraryException
static synchronized native int | H5Punregister (long plid, String name) throws HDF5LibraryException

## Function Documentation

## ◆ H5P_equal()

static boolean H5P_equal | ( | long | plid1,
|  | long | plid2 ) throws HDF5LibraryException
| static

H5Pequal determines if two property lists or classes are equal

Parameters

  plid1 | IN: First property object to be compared
  plid2 | IN: Second property object to be compared

Returns
  TRUE if equal, FALSE if unequal

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pall_filters_avail()

static synchronized native boolean H5Pall_filters_avail | ( | long | dcpl_id | ) | throws HDF5LibraryException, NullPointerException
| static

H5Pall_filters_avail query to verify that all the filters set in the dataset creation property list are available currently.

Parameters

  dcpl_id | IN: Property list identifier.

Returns
  TRUE if all filters available FALSE if one or more filters not currently available.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pclose()

static int H5Pclose | ( | long | plist | ) | throws HDF5LibraryException
| static

H5Pclose terminates access to a property list.

Parameters

  plist | IN: Identifier of the property list to terminate access to.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pclose_class()

static int H5Pclose_class | ( | long | plid | ) | throws HDF5LibraryException
| static

Closes an existing property list class

Parameters

  plid | IN: Property list class to close

Returns
  a non-negative value if successful; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pcopy()

static long H5Pcopy | ( | long | plist | ) | throws HDF5LibraryException
| static

H5Pcopy copies an existing property list to create a new property list.

Parameters

  plist | IN: Identifier of property list to duplicate.

Returns
  a property list identifier if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pcopy_prop()

static synchronized native int H5Pcopy_prop | ( | long | dst_id,
|  | long | src_id,
|  | String | name ) throws HDF5LibraryException
| static

H5Pcopy_prop copies a property from one property list or class to another

Parameters

  dst_id | IN: Identifier of the destination property list or class
  src_id | IN: Identifier of the source property list or class
  name | IN: Name of the property to copy

Returns
  a non-negative value if successful; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pcreate()

static long H5Pcreate | ( | long | type | ) | throws HDF5LibraryException
| static

H5Pcreate creates a new property as an instance of some property list class.

Parameters

  type | IN: The type of property list to create.

Returns
  a property list identifier (plist) if successful; otherwise Fail (-1).

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pcreate_class_nocb()

static long H5Pcreate_class_nocb | ( | long | parent_class,
|  | String | name ) throws HDF5LibraryException
| static

H5Pcreate_class_nocb creates an new property class with no callback functions.

Parameters

  parent_class | IN: Identifier of the parent property class.
  name | IN: Name of the property class.

Returns
  a property list identifier if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pequal()

static synchronized native int H5Pequal | ( | long | plid1,
|  | long | plid2 ) throws HDF5LibraryException
| static

H5Pequal determines if two property lists or classes are equal

Parameters

  plid1 | IN: First property object to be compared
  plid2 | IN: Second property object to be compared

Returns
  positive value if equal; zero if unequal, a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pexist()

static synchronized native boolean H5Pexist | ( | long | plid,
|  | String | name ) throws HDF5LibraryException
| static

H5Pexist determines whether a property exists within a property list or class

Parameters

  plid | IN: Identifier for the property to query
  name | IN: Name of property to check for

Returns
  a true value if the property exists in the property object; false if the property does not exist;

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pfill_value_defined()

static synchronized native int H5Pfill_value_defined | ( | long | plist_id,
|  | int[] | status ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_fill_value checks if the fill value is defined for a dataset creation property list.

Parameters

  plist_id | IN: Property list identifier.
  status | IN: The fill value setting: H5D_FILL_VALUE_UNDEFINED H5D_FILL_VALUE_DEFAULT H5D_FILL_VALUE_USER_DEFINED H5D_FILL_VALUE_ERROR

Returns
  a non-negative value if successful

Exceptions

  HDF5Exception | Error converting data array

## ◆ H5Pget()

static synchronized native int H5Pget | ( | long | plid,
|  | String | name ) throws HDF5LibraryException
| static

H5Pget retrieves a copy of the value for a property in a property list (support integer only)

Parameters

  plid | IN: Identifier of property object to query
  name | IN: Name of property to query

Returns
  value for a property if successful; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_alignment()

static synchronized native int H5Pget_alignment | ( | long | plist,
|  | long[] | alignment ) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
| static

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

Parameters

  plist | IN: Identifier of a file access property list.
  alignment | OUT: threshold value and alignment value.

         alignment[0] = threshold // threshold value
         alignment[1] = alignment // alignment value

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | alignment array is null.
  IllegalArgumentException | alignment array is invalid.

## ◆ H5Pget_alloc_time()

static synchronized native int H5Pget_alloc_time | ( | long | plist_id,
|  | int[] | alloc_time ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_alloc_time Gets space allocation time for dataset during creation.

Parameters

  plist_id | IN: Dataset creation property list identifier.
  alloc_time | OUT: allocation time.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_attr_creation_order()

static synchronized native int H5Pget_attr_creation_order | ( | long | ocpl_id | ) | throws HDF5LibraryException
| static

H5Pget_attr_creation_order retrieves the settings for tracking and indexing attribute creation order on an object.

Parameters

  ocpl_id | IN: Object (group or dataset) creation property list identifier

Returns
  Flags specifying whether to track and index attribute creation order

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_attr_phase_change()

static synchronized native int H5Pget_attr_phase_change | ( | long | ocpl_id,
|  | int[] | attributes ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_attr_phase_change retrieves attribute storage phase change thresholds.

Parameters

  ocpl_id | IN: Object (dataset or group) creation property list identifier
  attributes | The maximum and minimum no. of attributes to be stored.

         attributes[0] =  The maximum number of attributes to be stored in compact storage
         attributes[1] =  The minimum number of attributes to be stored in dense storage

Returns
  Returns a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | size is null.

## ◆ H5Pget_btree_ratios()

static synchronized native int H5Pget_btree_ratios | ( | long | plist_id,
|  | double[] | left,
|  | double[] | middle,
|  | double[] | right ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_btree_ratio Get the B-tree split ratios for a dataset transfer property list.

Parameters

  plist_id | IN Dataset transfer property list
  left | OUT split ratio for leftmost nodes
  right | OUT split ratio for righttmost nodes
  middle | OUT split ratio for all other nodes

Returns
  non-negative if succeed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | an input array is null.

## ◆ H5Pget_buffer()

static synchronized native int H5Pget_buffer | ( | long | plist,
|  | byte[] | tconv,
|  | byte[] | bkg ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_buffer gets type conversion and background buffers. Returns buffer size, in bytes, if successful; otherwise 0 on failure.

Parameters

  plist | Identifier for the dataset transfer property list.
  tconv | byte array of application-allocated type conversion buffer.
  bkg | byte array of application-allocated background buffer.

Returns
  buffer size, in bytes, if successful; otherwise 0 on failure

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | plist is invalid.

## ◆ H5Pget_buffer_size()

static synchronized native long H5Pget_buffer_size | ( | long | plist | ) | throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_buffer_size gets type conversion and background buffer size, in bytes, if successful; otherwise 0 on failure.

Parameters

  plist | Identifier for the dataset transfer property list.

Returns
  buffer size, in bytes, if successful; otherwise 0 on failure

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | plist is invalid.

## ◆ H5Pget_cache()

static synchronized native int H5Pget_cache | ( | long | plist,
|  | int[] | mdc_nelmts,
|  | long[] | rdcc_nelmts,
|  | long[] | rdcc_nbytes,
|  | double[] | rdcc_w0 ) throws HDF5LibraryException, NullPointerException
| static

Retrieves the maximum possible number of elements in the meta data cache and the maximum possible number of bytes and the RDCC_W0 value in the raw data chunk cache.

Parameters

  plist | IN: Identifier of the file access property list.
  mdc_nelmts | IN/OUT: No longer used, will be ignored.
  rdcc_nelmts | IN/OUT: Number of elements (objects) in the raw data chunk cache.
  rdcc_nbytes | IN/OUT: Total size of the raw data chunk cache, in bytes.
  rdcc_w0 | IN/OUT: Preemption policy.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | an array is null.

## ◆ H5Pget_char_encoding()

static synchronized native int H5Pget_char_encoding | ( | long | plist_id | ) | throws HDF5LibraryException
| static

H5Pget_char_encoding gets the character encoding of the string.

Parameters

  plist_id | IN: the property list identifier

Returns
  Returns the character encoding of the string.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_chunk()

static synchronized native int H5Pget_chunk | ( | long | plist,
|  | int | max_ndims,
|  | long[] | dims ) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
| static

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

Parameters

  plist | IN: Identifier of property list to query.
  max_ndims | IN: Size of the dims array.
  dims | OUT: Array to store the chunk dimensions.

Returns
  chunk dimensionality successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | dims array is null.
  IllegalArgumentException | max_ndims <=0

## ◆ H5Pget_chunk_cache()

static synchronized native void H5Pget_chunk_cache | ( | long | dapl_id,
|  | long[] | rdcc_nslots,
|  | long[] | rdcc_nbytes,
|  | double[] | rdcc_w0 ) throws HDF5LibraryException, NullPointerException
| static

Retrieves the maximum possible number of elements in the meta data cache and the maximum possible number of bytes and the RDCC_W0 value in the raw data chunk cache on a per-datset basis.

Parameters

  dapl_id | IN: Identifier of the dataset access property list.
  rdcc_nslots | IN/OUT: Number of elements (objects) in the raw data chunk cache.
  rdcc_nbytes | IN/OUT: Total size of the raw data chunk cache, in bytes.
  rdcc_w0 | IN/OUT: Preemption policy.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | an array is null.

## ◆ H5Pget_chunk_opts()

static synchronized native int H5Pget_chunk_opts | ( | long | dcpl_id | ) | throws HDF5LibraryException
| static

H5Pget_chunk_opts retrieves the edge chunk option setting stored in the dataset creation property list

Parameters

  dcpl_id | IN: Dataset creation property list

Returns
  The edge chunk option setting.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library

## ◆ H5Pget_class()

static synchronized native long H5Pget_class | ( | long | plist | ) | throws HDF5LibraryException
| static

H5Pget_class returns the property list class for the property list identified by the plist parameter.

Parameters

  plist | IN: Identifier of property list to query.

Returns
  a property list class if successful. Otherwise returns H5P_ROOT (-1).

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_class_name()

static synchronized native String H5Pget_class_name | ( | long | plid | ) | throws HDF5LibraryException
| static

H5Pget_class_name retrieves the name of a generic property list class

Parameters

  plid | IN: Identifier of property object to query

Returns
  name of a property list if successful; null if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_class_parent()

static synchronized native long H5Pget_class_parent | ( | long | plid | ) | throws HDF5LibraryException
| static

H5Pget_class_parent retrieves an identifier for the parent class of a property class

Parameters

  plid | IN: Identifier of the property class to query

Returns
  a valid parent class object identifier if successful; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_copy_object()

static synchronized native int H5Pget_copy_object | ( | long | ocp_plist_id | ) | throws HDF5LibraryException
| static

H5Pget_copy_object retrieves the properties to be used when an object is copied.

Parameters

  ocp_plist_id | IN: Object copy property list identifier

Returns
  Copy option(s) set in the object copy property list

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_create_intermediate_group()

static synchronized native boolean H5Pget_create_intermediate_group | ( | long | lcpl_id | ) | throws HDF5LibraryException
| static

H5Pget_create_intermediate_group determines whether property is set to enable creating missing intermediate groups.

Parameters

  lcpl_id | IN: Link creation property list identifier

Returns
  Boolean true or false

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_data_transform()

static synchronized native long H5Pget_data_transform | ( | long | plist_id,
|  | String[] | expression,
|  | long | size ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_data_transform retrieves the data transform expression previously set in the dataset transfer property list plist_id by H5Pset_data_transform.

Parameters

  plist_id | IN: Identifier of the property list or class
  size | IN: Number of bytes of the transform expression to copy to
  expression | OUT: A data transform expression

Returns
  The size of the transform expression if successful; 0(zero) if no transform expression exists. Otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Size is <= 0.

## ◆ H5Pget_driver()

static synchronized native long H5Pget_driver | ( | long | plid | ) | throws HDF5LibraryException
| static

H5Pget_driver returns the identifier of the low-level file driver associated with the file access property list or data transfer property list plid.

Parameters

  plid | IN: File access or data transfer property list identifier.

Returns
  a valid low-level driver identifier if successful; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_dset_no_attrs_hint()

static synchronized native boolean H5Pget_dset_no_attrs_hint | ( | long | dcpl_id | ) | throws HDF5LibraryException
| static

H5Pget_dset_no_attrs_hint accesses the flag for whether or not datasets created by the given dcpl will be created with a "minimized" object header.

Parameters

  dcpl_id | IN: Dataset creation property list

Returns
  true if the given dcpl is set to create minimized dataset object headers, false if not.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_edc_check()

static synchronized native int H5Pget_edc_check | ( | long | plist | ) | throws HDF5LibraryException
| static

H5Pget_edc_check gets the error-detecting algorithm in use.

Parameters

  plist | Identifier for the dataset transfer property list.

Returns
  the error-detecting algorithm

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_efile_prefix()

static synchronized native String H5Pget_efile_prefix | ( | long | dapl_id | ) | throws HDF5LibraryException
| static

H5Pget_efile_prefix Retrieves prefix applied to external file paths.

Parameters

  dapl_id | IN: Link access property list identifier

Returns
  the prefix to be applied to external file paths.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_elink_acc_flags()

static synchronized native int H5Pget_elink_acc_flags | ( | long | lapl_id | ) | throws HDF5LibraryException
| static

H5Pget_elink_acc_flags retrieves the external link traversal file access flag from the specified link access property list.

Parameters

  lapl_id | IN: Link access property list identifier

Returns
  File access flag for link traversal.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_elink_fapl()

static long H5Pget_elink_fapl | ( | long | lapl_id | ) | throws HDF5LibraryException
| static

H5Pget_elink_fapl Retrieves the file access property list identifier associated with the link access property list.

Parameters

  lapl_id | IN: Link access property list identifier

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_elink_file_cache_size()

static synchronized native int H5Pget_elink_file_cache_size | ( | long | fapl_id | ) | throws HDF5LibraryException
| static

H5Pget_elink_file_cache_size retrieves the size of the external link open file cache.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  External link open file cache size in number of files.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_elink_prefix()

static synchronized native long H5Pget_elink_prefix | ( | long | lapl_id,
|  | String[] | prefix ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_elink_prefix Retrieves prefix applied to external link paths.

Parameters

  lapl_id | IN: Link access property list identifier
  prefix | OUT: Prefix applied to external link paths

Returns
  If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL terminator; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | prefix is null.

## ◆ H5Pget_est_link_info()

static synchronized native int H5Pget_est_link_info | ( | long | gcpl_id,
|  | int[] | link_info ) throws HDF5LibraryException, NullPointerException
| static

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

Parameters

  gcpl_id | IN: Group creation property list identifier
  link_info | Estimated number of links to be inserted into group And the estimated average length of link names

         link_info[0] =  Estimated number of links to be inserted into group
         link_info[1] =  Estimated average length of link names

Returns
  Returns a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | link_info is null.

## ◆ H5Pget_evict_on_close()

static synchronized native boolean H5Pget_evict_on_close | ( | long | fapl_id | ) | throws HDF5LibraryException
| static

H5Pget_evict_on_close retrieves the file access property list setting that determines whether an HDF5 object will be evicted from the library's metadata cache when it is closed.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  indication if the object will be evicted on close.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_external()

static synchronized native int H5Pget_external | ( | long | plist,
|  | int | idx,
|  | long | name_size,
|  | String[] | name,
|  | long[] | size ) throws ArrayIndexOutOfBoundsException, ArrayStoreException, HDF5LibraryException, NullPointerException, IllegalArgumentException
| static

H5Pget_external returns information about an external file.

Parameters

  plist | IN: Identifier of a dataset creation property list.
  idx | IN: External file index.
  name_size | IN: Maximum length of name array.
  name | OUT: Name of the external file.
  size | OUT: the offset value and the size of the external file data.

       size[0] = offset // a location to return an offset value
       size[1] = size // a location to return the size of the external file data.

Returns
  a non-negative value if successful

Exceptions

  ArrayIndexOutOfBoundsException | Fatal error on Copyback
  ArrayStoreException | Fatal error on Copyback
  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | name or size is null.
  IllegalArgumentException | name_size <= 0 .

## ◆ H5Pget_external_count()

static synchronized native int H5Pget_external_count | ( | long | plist | ) | throws HDF5LibraryException
| static

H5Pget_external_count returns the number of external files for the specified dataset.

Parameters

  plist | IN: Identifier of a dataset creation property list.

Returns
  the number of external files if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_family_offset()

static synchronized native long H5Pget_family_offset | ( | long | fapl_id | ) | throws HDF5LibraryException
| static

H5Pget_family_offset gets offset for family driver.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  the offset.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_fapl_core()

static synchronized native void H5Pget_fapl_core | ( | long | fapl_id,
|  | long[] | increment,
|  | boolean[] | backing_store ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_fapl_core retrieve H5FD_CORE I/O settings.

Parameters

  fapl_id | IN: File access property list identifier
  increment | OUT: how much to grow the memory each time
  backing_store | OUT: write to file name on flush setting

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_fapl_direct()

static synchronized native int H5Pget_fapl_direct | ( | long | fapl_id,
|  | long[] | info ) throws HDF5LibraryException
| static

H5Pget_fapl_direct queries properties set by the H5Pset_fapl_direct.

Parameters

  fapl_id | IN: File access property list identifier
  info | OUT: Returned property list information info[0] = increment -how much to grow the memory each time info[1] = backing_store - write to file name on flush setting

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_fapl_family()

static synchronized native int H5Pget_fapl_family | ( | long | fapl_id,
|  | long[] | memb_size,
|  | long[] | memb_fapl_id ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_fapl_family Returns information about the family file access property list.

Parameters

  fapl_id | IN: File access property list identifier
  memb_size | OUT: the size in bytes of each file member (used only when creating a new file)
  memb_fapl_id | OUT: the file access property list to be used for each family member

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_fapl_hdfs()

static synchronized native H5FD_hdfs_fapl_t H5Pget_fapl_hdfs | ( | long | fapl_id | ) | throws HDF5LibraryException, NullPointerException
| static

H5Pget_fapl_hdfs gets the properties hdfs I/O driver.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  the properties of the hdfs driver.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_fapl_multi()

static synchronized native boolean H5Pget_fapl_multi | ( | long | fapl_id,
|  | int[] | memb_map,
|  | long[] | memb_fapl,
|  | String[] | memb_name,
|  | long[] | memb_addr ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_fapl_multi Sets up use of the multi I/O driver.

Parameters

  fapl_id | IN: File access property list identifier
  memb_map | IN: Maps memory usage types to other memory usage types.
  memb_fapl | IN: Property list for each memory usage type.
  memb_name | IN: Name generator for names of member files.
  memb_addr | IN: The offsets within the virtual address space, from 0 (zero) to HADDR_MAX, at which each type of data storage begins.

Returns
  a boolean value; Allows read-only access to incomplete file sets when TRUE.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | an array is null.

## ◆ H5Pget_fapl_ros3()

static synchronized native H5FD_ros3_fapl_t H5Pget_fapl_ros3 | ( | long | fapl_id | ) | throws HDF5LibraryException, NullPointerException
| static

H5Pget_fapl_ros3 gets the properties of the ros3 I/O driver.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  the properties of the ros3 driver.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_fclose_degree()

static synchronized native int H5Pget_fclose_degree | ( | long | fapl_id | ) | throws HDF5LibraryException, NullPointerException
| static

H5Pget_fclose_degree returns the degree for the file close behavior for a file access property list.

Parameters

  fapl_id | IN File access property list

Returns
  the degree for the file close behavior

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_file_space_page_size()

static synchronized native long H5Pget_file_space_page_size | ( | long | fcpl_id | ) | throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_file_space_page_size Sets the file space page size for paged aggregation.

Parameters

  fcpl_id | IN: File creation property list identifier

Returns
  the current file space page size.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid values of max_list and min_btree.

## ◆ H5Pget_file_space_strategy()

static synchronized native int H5Pget_file_space_strategy | ( | long | fcpl_id,
|  | boolean[] | persist,
|  | long[] | threshold ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_file_space_strategy provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.

Parameters

  fcpl_id | IN: File creation property list identifier
  persist | IN/OUT: The current free-space persistence. NULL, persist not queried.
  threshold | IN/OUT: The current free-space section threshold. NULL, threshold not queried.

Returns
  the current free-space strategy.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid values of max_list and min_btree.

## ◆ H5Pget_file_space_strategy_persist()

static synchronized native boolean H5Pget_file_space_strategy_persist | ( | long | fcpl_id | ) | throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_file_space_strategy_persist provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.

Parameters

  fcpl_id | IN: File creation property list identifier

Returns
  the current free-space persistence.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid values of max_list and min_btree.

## ◆ H5Pget_file_space_strategy_threshold()

static synchronized native long H5Pget_file_space_strategy_threshold | ( | long | fcpl_id | ) | throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_file_space_strategy_threshold provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.

Parameters

  fcpl_id | IN: File creation property list identifier

Returns
  the current free-space section threshold.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid values of max_list and min_btree.

## ◆ H5Pget_fill_time()

static synchronized native int H5Pget_fill_time | ( | long | plist_id,
|  | int[] | fill_time ) throws HDF5LibraryException
| static

H5Pset_fill_time Gets fill value writing time.

Parameters

  plist_id | IN: Dataset creation property list identifier.
  fill_time | OUT: fill time.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_fill_value() [1/2]

static synchronized native int H5Pget_fill_value | ( | long | plist_id,
|  | long | type_id,
|  | byte[] | value ) throws HDF5Exception
| static

H5Pget_fill_value queries the fill value property of a dataset creation property list.

Parameters

  plist_id | IN: Property list identifier.
  type_id | IN: The datatype identifier of value.
  value | IN: The fill value.

Returns
  a non-negative value if successful

Exceptions

  HDF5Exception | Error converting data array.

## ◆ H5Pget_fill_value() [2/2]

static synchronized int H5Pget_fill_value | ( | long | plist_id,
|  | long | type_id,
|  | Object | obj ) throws HDF5Exception
| static

H5Pget_fill_value queries the fill value property of a dataset creation property list.

Parameters

  plist_id | IN: Property list identifier.
  type_id | IN: The datatype identifier of value.
  obj | IN: The fill value.

Returns
  a non-negative value if successful

Exceptions

  HDF5Exception | Error converting data array.

## ◆ H5Pget_filter()

static int H5Pget_filter | ( | long | plist,
|  | int | filter_number,
|  | int[] | flags,
|  | long[] | cd_nelmts,
|  | int[] | cd_values,
|  | long | namelen,
|  | String[] | name,
|  | int[] | filter_config ) throws ArrayIndexOutOfBoundsException, ArrayStoreException, HDF5LibraryException, NullPointerException
| static

H5Pget_filter returns information about a filter, specified by its filter number, in a filter pipeline, specified by the property list with which it is associated.

Parameters

  plist | IN: Property list identifier.
  filter_number | IN: Sequence number within the filter pipeline of the filter for which information is sought.
  flags | OUT: Bit vector specifying certain general properties of the filter.
  cd_nelmts | IN/OUT: Number of elements in cd_values
  cd_values | OUT: Auxiliary data for the filter.
  namelen | IN: Anticipated number of characters in name.
  name | OUT: Name of the filter.
  filter_config | OUT:A bit field encoding the returned filter information

Returns
  the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).

Exceptions

  ArrayIndexOutOfBoundsException | Fatal error on Copyback
  ArrayStoreException | Fatal error on Copyback
  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | name or an array is null.

## ◆ H5Pget_filter_by_id()

static int H5Pget_filter_by_id | ( | long | plist_id,
|  | long | filter_id,
|  | int[] | flags,
|  | long[] | cd_nelmts,
|  | int[] | cd_values,
|  | long | namelen,
|  | String[] | name,
|  | int[] | filter_config ) throws ArrayIndexOutOfBoundsException, ArrayStoreException, HDF5LibraryException, NullPointerException
| static

H5Pget_filter_by_id returns information about the filter specified in filter_id, a filter identifier. plist_id must be a dataset or group creation property list and filter_id must be in the associated filter pipeline. The filter_id and flags parameters are used in the same manner as described in the discussion of H5Pset_filter. Aside from the fact that they are used for output, the parameters cd_nelmts and cd_values[] are used in the same manner as described in the discussion of H5Pset_filter. On input, the cd_nelmts parameter indicates the number of entries in the cd_values[] array allocated by the calling program; on exit it contains the number of values defined by the filter. On input, the namelen parameter indicates the number of characters allocated for the filter name by the calling program in the array name[]. On exit name[] contains the name of the filter with one character of the name in each element of the array. If the filter specified in filter_id is not set for the property list, an error will be returned and H5Pget_filter_by_id1 will fail.

Parameters

  plist_id | IN: Property list identifier.
  filter_id | IN: Filter identifier.
  flags | OUT: Bit vector specifying certain general properties of the filter.
  cd_nelmts | N/OUT: Number of elements in cd_values
  cd_values | OUT: Auxiliary data for the filter.
  namelen | IN: Anticipated number of characters in name.
  name | OUT: Name of the filter.
  filter_config | OUT: A bit field encoding the returned filter information

Returns
  the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  ArrayIndexOutOfBoundsException | Fatal error on Copyback
  ArrayStoreException | Fatal error on Copyback
  NullPointerException | name or an array is null.

## ◆ H5Pget_filter_by_id2()

static synchronized native int H5Pget_filter_by_id2 | ( | long | plist_id,
|  | long | filter_id,
|  | int[] | flags,
|  | long[] | cd_nelmts,
|  | int[] | cd_values,
|  | long | namelen,
|  | String[] | name,
|  | int[] | filter_config ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_filter_by_id2 returns information about a filter, specified by its filter id, in a filter pipeline, specified by the property list with which it is associated.

Parameters

  plist_id | IN: Property list identifier.
  filter_id | IN: Filter identifier.
  flags | OUT: Bit vector specifying certain general properties of the filter.
  cd_nelmts | N/OUT: Number of elements in cd_values
  cd_values | OUT: Auxiliary data for the filter.
  namelen | IN: Anticipated number of characters in name.
  name | OUT: Name of the filter.
  filter_config | OUT: A bit field encoding the returned filter information

Returns
  the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | name or an array is null.

## ◆ H5Pget_gc_references()

static synchronized native boolean H5Pget_gc_references | ( | long | fapl_id | ) | throws HDF5LibraryException
| static

H5Pget_gc_references Returns the current setting for the garbage collection references property from a file access property list.

Parameters

  fapl_id | IN File access property list

Returns
  GC is on (true) or off (false)

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_hyper_vector_size()

static synchronized native int H5Pget_hyper_vector_size | ( | long | dxpl_id,
|  | long[] | vector_size ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_hyper_vector_size reads values previously set with H5Pset_hyper_vector_size.

Parameters

  dxpl_id | IN: Dataset transfer property list identifier.
  vector_size | OUT: hyper vector size.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_ignore_disabled_file_locking()

static synchronized native boolean H5Pget_ignore_disabled_file_locking | ( | long | fapl_id | ) | throws HDF5LibraryException
| static

H5Pget_use_file_locking retrieves whether we ignore file locks when they are disabled.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  indication if file locking is ignored.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_istore_k()

static synchronized native int H5Pget_istore_k | ( | long | plist,
|  | int[] | ik ) throws HDF5LibraryException, NullPointerException
| static

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

Parameters

  plist | IN: Identifier of property list to query.
  ik | OUT: Pointer to location to return the chunked storage B-tree 1/2 rank.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | ik array is null.

## ◆ H5Pget_layout()

static synchronized native int H5Pget_layout | ( | long | plist | ) | throws HDF5LibraryException
| static

H5Pget_layout returns the layout of the raw data for a dataset.

Parameters

  plist | IN: Identifier for property list to query.

Returns
  the layout type of a dataset creation property list if successful. Otherwise returns H5D_LAYOUT_ERROR (-1).

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_libver_bounds()

static synchronized native int H5Pget_libver_bounds | ( | long | fapl_id,
|  | int[] | libver ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_libver_bounds retrieves the lower and upper bounds on the HDF5 Library versions that indirectly determine the object formats versions used when creating objects in the file.

Parameters

  fapl_id | IN: File access property list identifier
  libver | The earliest/latest version of the library that will be used for writing objects.

         libver[0] =  The earliest version of the library that will be used for writing objects
         libver[1] =  The latest version of the library that will be used for writing objects.

Returns
  Returns a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | size is null.

## ◆ H5Pget_link_creation_order()

static synchronized native int H5Pget_link_creation_order | ( | long | gcpl_id | ) | throws HDF5LibraryException
| static

H5Pget_link_creation_order queries the group creation property list, gcpl_id, and returns a flag indicating whether link creation order is tracked and/or indexed in a group.

Parameters

  gcpl_id | IN: Group creation property list identifier

Returns
  crt_order_flags -Creation order flag(s)

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_link_phase_change()

static synchronized native int H5Pget_link_phase_change | ( | long | gcpl_id,
|  | int[] | links ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_link_phase_change Queries the settings for conversion between compact and dense groups.

Parameters

  gcpl_id | IN: Group creation property list identifier
  links | The max. no. of compact links & the min. no. of dense links, which are used for storing groups

         links[0] =  The maximum number of links for compact storage
         links[1] =  The minimum number of links for dense storage

Returns
  Returns a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | size is null.

## ◆ H5Pget_local_heap_size_hint()

static synchronized native long H5Pget_local_heap_size_hint | ( | long | gcpl_id | ) | throws HDF5LibraryException
| static

H5Pget_local_heap_size_hint Retrieves the anticipated size of the local heap for original-style groups.

Parameters

  gcpl_id | IN: Group creation property list identifier

Returns
  size_hint, the anticipated size of local heap

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_mdc_config()

static synchronized native H5AC_cache_config_t H5Pget_mdc_config | ( | long | plist_id | ) | throws HDF5LibraryException
| static

H5Pget_mdc_config gets the initial metadata cache configuration contained in a file access property list. This configuration is used when the file is opened.

Parameters

  plist_id | IN: Identifier of the file access property list.

Returns
  A buffer(H5AC_cache_config_t) for the current metadata cache configuration information

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_mdc_log_options()

static synchronized native String H5Pget_mdc_log_options | ( | long | fapl_id,
|  | boolean[] | mdc_log_options ) throws HDF5LibraryException
| static

H5Pget_mdc_log_options gets metadata cache logging options.

Parameters

  fapl_id | IN: File access property list identifier
  mdc_log_options | the options mdc_logging_options[0] = is_enabled, whether logging is enabled mdc_logging_options[1] = start_on_access, whether the logging begins as soon as the file is opened or created

Returns
  the location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII).

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_meta_block_size()

static synchronized native long H5Pget_meta_block_size | ( | long | fapl_id | ) | throws HDF5LibraryException
| static

H5Pget_meta_block_size the current metadata block size setting.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  the minimum size, in bytes, of metadata block allocations.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_metadata_read_attempts()

static synchronized native long H5Pget_metadata_read_attempts | ( | long | plist_id | ) | throws HDF5LibraryException
| static

H5Pget_metadata_read_attempts retrieves the number of read attempts that is set in the file access property list plist_id.

Parameters

  plist_id | IN: File access property list identifier

Returns
  The number of read attempts.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_nfilters()

static synchronized native int H5Pget_nfilters | ( | long | plist | ) | throws HDF5LibraryException
| static

H5Pget_nfilters returns the number of filters defined in the filter pipeline associated with the property list plist.

Parameters

  plist | IN: Property list identifier.

Returns
  the number of filters in the pipeline if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_nlinks()

static synchronized native long H5Pget_nlinks | ( | long | lapl_id | ) | throws HDF5LibraryException
| static

H5Pget_nlinks retrieves the maximum number of soft or user-defined link traversals allowed, nlinks, before the library assumes it has found a cycle and aborts the traversal. This value is retrieved from the link access property list lapl_id.

Parameters

  lapl_id | IN: File access property list identifier

Returns
  Returns a Maximum number of links to traverse.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_nprops()

static synchronized native long H5Pget_nprops | ( | long | plid | ) | throws HDF5LibraryException
| static

H5Pget_nprops retrieves the number of properties in a property list or class

Parameters

  plid | IN: Identifier of property object to query

Returns
  number of properties if successful; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_obj_track_times()

static synchronized native boolean H5Pget_obj_track_times | ( | long | ocpl_id | ) | throws HDF5LibraryException
| static

H5Pget_obj_track_times queries the object creation property list, ocpl_id, to determine whether object times are being recorded.

Parameters

  ocpl_id | IN: Object creation property list identifier

Returns
  TRUE or FALSE, specifying whether object times are being recorded

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_shared_mesg_index()

static synchronized native int H5Pget_shared_mesg_index | ( | long | fcpl_id,
|  | int | index_num,
|  | int[] | mesg_info ) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
| static

H5Pget_shared_mesg_index Retrieves the configuration settings for a shared message index.

Parameters

  fcpl_id | IN: File creation property list identifier
  index_num | IN: Index being configured.
  mesg_info | The message type and minimum message size

         mesg_info[0] =  Types of messages that may be stored in this index.
         mesg_info[1] =  Minimum message size.

Returns
  Returns a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | mesg_info is null.
  IllegalArgumentException | Invalid value of nindexes

## ◆ H5Pget_shared_mesg_nindexes()

static synchronized native int H5Pget_shared_mesg_nindexes | ( | long | fcpl_id | ) | throws HDF5LibraryException
| static

H5Pget_shared_mesg_nindexes retrieves number of shared object header message indexes in file creation property list.

Parameters

  fcpl_id | IN: : File creation property list identifier

Returns
  nindexes, the number of shared object header message indexes available in files created with this property list

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_shared_mesg_phase_change()

static synchronized native int H5Pget_shared_mesg_phase_change | ( | long | fcpl_id,
|  | int[] | size ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_shared_mesg_phase_change retrieves shared object header message phase change information.

Parameters

  fcpl_id | IN: : File creation property list identifier
  size | The threshold values for storage of shared object header message indexes in a file.

         size[0] =  Threshold above which storage of a shared object header message index shifts from list
         to B-tree size[1] =  Threshold below which storage of a shared object header message index reverts
         to list format

Returns
  Returns a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | size is null.

## ◆ H5Pget_sieve_buf_size()

static synchronized native long H5Pget_sieve_buf_size | ( | long | fapl_id | ) | throws HDF5LibraryException
| static

H5Pget_sieve_buf_size retrieves the current settings for the data sieve buffer size property from a file access property list.

Parameters

  fapl_id | IN: Identifier for property list to query.

Returns
  a non-negative value and the size of the user block; if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_size()

static synchronized native long H5Pget_size | ( | long | plid,
|  | String | name ) throws HDF5LibraryException
| static

H5Pget_size retrieves the size of a property's value in bytes

Parameters

  plid | IN: Identifier of property object to query
  name | IN: Name of property to query

Returns
  size of a property's value if successful; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_sizes()

static synchronized native int H5Pget_sizes | ( | long | plist,
|  | long[] | size ) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
| static

H5Pget_sizes retrieves the size of the offsets and lengths used in an HDF5 file. This function is only valid for file creation property lists.

Parameters

  plist | IN: Identifier of property list to query.
  size | OUT: the size of the offsets and length.

         size[0] = sizeof_addr // offset size in bytes
         size[1] = sizeof_size // length size in bytes

Returns
  a non-negative value with the sizes initialized; if successful;

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | size is null.
  IllegalArgumentException | size is invalid.

## ◆ H5Pget_small_data_block_size()

static synchronized native long H5Pget_small_data_block_size | ( | long | plist | ) | throws HDF5LibraryException
| static

H5Pget_small_data_block_size retrieves the size of a block of small data in a file creation property list.

Parameters

  plist | IN: Identifier for property list to query.

Returns
  a non-negative value and the size of the user block; if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_sym_k()

static synchronized native int H5Pget_sym_k | ( | long | plist,
|  | int[] | size ) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
| static

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

Parameters

  plist | IN: Property list to query.
  size | OUT: the symbol table's B-tree 1/2 rank and leaf node 1/2size.

         size[0] = ik // the symbol table's B-tree 1/2 rank
         size[1] = lk // leaf node 1/2 size

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | size is null.
  IllegalArgumentException | size is invalid.

## ◆ H5Pget_use_file_locking()

static synchronized native boolean H5Pget_use_file_locking | ( | long | fapl_id | ) | throws HDF5LibraryException
| static

H5Pget_use_file_locking retrieves whether we are using file locking.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  indication if file locking is used.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_userblock()

static synchronized native int H5Pget_userblock | ( | long | plist,
|  | long[] | size ) throws HDF5LibraryException, NullPointerException
| static

H5Pget_userblock retrieves the size of a user block in a file creation property list.

Parameters

  plist | IN: Identifier for property list to query.
  size | OUT: Pointer to location to return user-block size.

Returns
  a non-negative value and the size of the user block; if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | size is null.

## ◆ H5Pget_virtual_count()

static synchronized native long H5Pget_virtual_count | ( | long | dcpl_id | ) | throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_virtual_count gets the number of mappings for a virtual dataset that has the creation property list specified by dcpl_id.

Parameters

  dcpl_id | IN: The identifier of the virtual dataset creation property list.

Returns
  a non-negative number of mappings if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | An id is <=0

## ◆ H5Pget_virtual_dsetname()

static synchronized native String H5Pget_virtual_dsetname | ( | long | dcpl_id,
|  | long | index ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_virtual_dsetname takes the dataset creation property list for the virtual dataset, dcpl_id, the mapping index, index, the size of the dataset name for a source dataset, size, and retrieves the name of the source dataset used in the mapping.

Parameters

  dcpl_id | IN: The identifier of the virtual dataset creation property list.
  index | IN: Mapping index.

Returns
  the name of the source dataset if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | An id is <=0

## ◆ H5Pget_virtual_filename()

static synchronized native String H5Pget_virtual_filename | ( | long | dcpl_id,
|  | long | index ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_virtual_filename takes the dataset creation property list for the virtual dataset, dcpl_id, the mapping index, index, the size of the filename for a source dataset, size, and retrieves the name of the file for a source dataset used in the mapping.

Parameters

  dcpl_id | IN: The identifier of the virtual dataset creation property list.
  index | IN: Mapping index.

Returns
  the name of the file containing the source dataset if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | An id is <=0

## ◆ H5Pget_virtual_prefix()

static synchronized native String H5Pget_virtual_prefix | ( | long | dapl_id | ) | throws HDF5LibraryException
| static

H5Pget_virtual_prefix Retrieves prefix applied to virtual file paths.

Parameters

  dapl_id | IN: Link access property list identifier

Returns
  the prefix to be applied to virtual file paths.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_virtual_printf_gap()

static synchronized native long H5Pget_virtual_printf_gap | ( | long | dapl_id | ) | throws HDF5LibraryException
| static

H5Pget_virtual_printf_gap returns the maximum number of missing printf-style files and/or datasets for determining the extent of an unlimited virtual dataaset, gap_size, using the access property list for the virtual dataset, dapl_id.

Parameters

  dapl_id | IN: Dataset access property list identifier for the virtual dataset

Returns
  Maximum number of files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library

## ◆ H5Pget_virtual_spatial_tree()

static synchronized native boolean H5Pget_virtual_spatial_tree | ( | long | dapl_id | ) | throws HDF5LibraryException
| static

H5Pget_virtual_spatial_tree accesses the flag for whether to use/not use a spatial tree during mapping operations on a Virtual Dataset. The default value is true.

Use of a spatial tree will accelerate the process of searching through mappings to determine which contain intersections with the user's selection region. With the tree disabled, all mappings will simply be iterated through and checked directly.

Certain workflows may find that tree creation overhead outweighs the time saved on reads. In this case, disabling this property will lead to a performance improvement, though it is expected that almost all cases will benefit from the tree on net.

Parameters

  dapl_id | IN: Dataset access property list

Returns
  true if the given dapl is set to use a spatial tree, false if not.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pget_virtual_srcspace()

static synchronized native long H5Pget_virtual_srcspace | ( | long | dcpl_id,
|  | long | index ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_virtual_srcspace takes the dataset creation property list for the virtual dataset, dcpl_id, and the mapping index, index, and returns a dataspace identifier for the selection within the source dataset used in the mapping.

Parameters

  dcpl_id | IN: The identifier of the virtual dataset creation property list.
  index | IN: Mapping index.

Returns
  a valid dataspace identifier if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | An id is <=0

## ◆ H5Pget_virtual_view()

static synchronized native int H5Pget_virtual_view | ( | long | dapl_id | ) | throws HDF5LibraryException
| static

H5Pget_virtual_view takes the virtual dataset access property list, dapl_id, and retrieves the flag, view, set by the H5Pset_virtual_view call.

Parameters

  dapl_id | IN: Dataset access property list identifier for the virtual dataset

Returns
  The flag specifying the view of the virtual dataset.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library

## ◆ H5Pget_virtual_vspace()

static synchronized native long H5Pget_virtual_vspace | ( | long | dcpl_id,
|  | long | index ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pget_virtual_vspace takes the dataset creation property list for the virtual dataset, dcpl_id, and the mapping index, index, and returns a dataspace identifier for the selection within the virtual dataset used in the mapping.

Parameters

  dcpl_id | IN: The identifier of the virtual dataset creation property list.
  index | IN: Mapping index.

Returns
  a valid dataspace identifier if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | An id is <=0

## ◆ H5Pinsert2_nocb()

static synchronized native void H5Pinsert2_nocb | ( | long | plist,
|  | String | name,
|  | long | size,
|  | byte[] | value ) throws HDF5LibraryException
| static

H5Pinsert2_nocb inserts a property list with no callback functions.

Parameters

  plist | IN: Identifier of the property list.
  name | IN: Name of the property.
  size | IN: Size the property value.
  value | IN: Default value of the property

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pisa_class()

static synchronized native int H5Pisa_class | ( | long | plist,
|  | long | pclass ) throws HDF5LibraryException
| static

H5Pisa_class checks to determine whether a property list is a member of the specified class

Parameters

  plist | IN: Identifier of the property list
  pclass | IN: Identifier of the property class

Returns
  a positive value if equal; zero if unequal; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Piterate()

static synchronized native int H5Piterate | ( | long | plist,
|  | int[] | idx,
|  | H5P_iterate_cb | op,
|  | H5P_iterate_t | op_data ) throws HDF5LibraryException
| static

H5Piterate iterates over the properties in a property list or class

Parameters

  plist | IN: ID of property object to iterate over
  idx | IN/OUT: index of the property to begin with
  op | IN: function to be called with each property iterated over.
  op_data | IN: iteration data from user

Returns
  the return value of the last call to op if it was non-zero, zero if all properties have been processed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | size is null.

## ◆ H5Pmodify_filter()

static synchronized native int H5Pmodify_filter | ( | long | plist,
|  | long | filter,
|  | int | flags,
|  | long | cd_nelmts,
|  | int[] | cd_values ) throws HDF5LibraryException, NullPointerException
| static

H5Pmodify_filter modifies the specified FILTER in the transient or permanent output filter pipeline depending on whether PLIST is a dataset creation or dataset transfer property list. The FLAGS argument specifies certain general properties of the filter and is documented below. The CD_VALUES is an array of CD_NELMTS integers which are auxiliary data for the filter. The integer values will be stored in the dataset object header as part of the filter information.

The FLAGS argument is a bit vector of the following fields:

H5Z_FLAG_OPTIONAL(0x0001) If this bit is set then the filter is optional. If the filter fails during an H5Dwrite() operation then the filter is just excluded from the pipeline for the chunk for which it failed; the filter will not participate in the pipeline during an H5Dread() of the chunk. If this bit is clear and the filter fails then the entire I/O operation fails. If this bit is set but encoding is disabled for a filter, attempting to write will generate an error.

Note: This function currently supports only the permanent filter pipeline. That is, PLIST_ID must be a dataset creation property list.

Parameters

  plist | IN: Property list identifier.
  filter | IN: Filter to be modified to the pipeline.
  flags | IN: Bit vector specifying certain general properties of the filter.
  cd_nelmts | IN: Number of elements in cd_values
  cd_values | IN: Auxiliary data for the filter.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | name or an array is null.

## ◆ H5Pregister2_nocb()

static synchronized native void H5Pregister2_nocb | ( | long | plist_class,
|  | String | name,
|  | long | size,
|  | byte[] | def_value ) throws HDF5LibraryException
| static

H5Pregister2_nocb registers a property list with no callback functions.

Parameters

  plist_class | IN: Identifier of the property list.
  name | IN: Name of the property.
  size | IN: Size the property value.
  def_value | IN: Default value of the property

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Premove()

static synchronized native int H5Premove | ( | long | plid,
|  | String | name ) throws HDF5LibraryException
| static

H5Premove removes a property from a property list

Parameters

  plid | IN: Identifier of the property list to modify
  name | IN: Name of property to remove

Returns
  a non-negative value if successful; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Premove_filter()

static synchronized native int H5Premove_filter | ( | long | obj_id,
|  | long | filter ) throws HDF5LibraryException
| static

H5Premove_filter deletes a filter from the dataset creation property list; deletes all filters if filter is H5Z_FILTER_ALL

Parameters

  obj_id | IN: Property list identifier.
  filter | IN: Filter identifier.

Returns
  a non-negative value and the size of the user block; if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset()

static synchronized native int H5Pset | ( | long | plid,
|  | String | name,
|  | int | value ) throws HDF5LibraryException
| static

Sets a property list value (support integer only)

Parameters

  plid | IN: Property list identifier to modify
  name | IN: Name of property to modify
  value | IN: value to set the property to

Returns
  a non-negative value if successful; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_alignment()

static synchronized native int H5Pset_alignment | ( | long | plist,
|  | long | threshold,
|  | long | alignment ) throws HDF5LibraryException
| static

H5Pset_alignment sets the alignment properties of a file access property list so that any file object >= THRESHOLD bytes will be aligned on an address which is a multiple of ALIGNMENT.

Parameters

  plist | IN: Identifier for a file access property list.
  threshold | IN: Threshold value.
  alignment | IN: Alignment value.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_alloc_time()

static synchronized native int H5Pset_alloc_time | ( | long | plist_id,
|  | int | alloc_time ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_alloc_time Sets space allocation time for dataset during creation.

Parameters

  plist_id | IN: Dataset creation property list identifier.
  alloc_time | IN: allocation time.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_attr_creation_order()

static synchronized native int H5Pset_attr_creation_order | ( | long | ocpl_id,
|  | int | crt_order_flags ) throws HDF5LibraryException
| static

H5Pset_attr_creation_order sets flags specifying whether to track and index attribute creation order on an object.

Parameters

  ocpl_id | IN: Object creation property list identifier
  crt_order_flags | IN: Flags specifying whether to track and index attribute creation order

Returns
  Returns a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_attr_phase_change()

static synchronized native void H5Pset_attr_phase_change | ( | long | ocpl_id,
|  | int | max_compact,
|  | int | min_dense ) throws HDF5LibraryException
| static

H5Pset_attr_phase_change sets threshold values for attribute storage on an object. These thresholds determine the point at which attribute storage changes from compact storage (i.e., storage in the object header) to dense storage (i.e., storage in a heap and indexed with a B-tree).

Parameters

  ocpl_id | IN: : Object (dataset or group) creation property list identifier
  max_compact | IN: Maximum number of attributes to be stored in compact storage (Default: 8)
  min_dense | IN: Minimum number of attributes to be stored in dense storage (Default: 6)

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_btree_ratios()

static synchronized native int H5Pset_btree_ratios | ( | long | plist_id,
|  | double | left,
|  | double | middle,
|  | double | right ) throws HDF5LibraryException
| static

H5Pset_btree_ratio Sets B-tree split ratios for a dataset transfer property list. The split ratios determine what percent of children go in the first node when a node splits.

Parameters

  plist_id | IN Dataset transfer property list
  left | IN split ratio for leftmost nodes
  right | IN split ratio for righttmost nodes
  middle | IN split ratio for all other nodes

Returns
  non-negative if succeed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_buffer_size()

static synchronized native void H5Pset_buffer_size | ( | long | plist,
|  | long | size ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pset_buffer sets type conversion and background buffers. status to TRUE or FALSE.

Given a dataset transfer property list, H5Pset_buffer sets the maximum size for the type conversion buffer and background buffer and optionally supplies pointers to application-allocated buffers. If the buffer size is smaller than the entire amount of data being transferred between the application and the file, and a type conversion buffer or background buffer is required, then strip mining will be used.

Note that there are minimum size requirements for the buffer. Strip mining can only break the data up along the first dimension, so the buffer must be large enough to accommodate a complete slice that encompasses all of the remaining dimensions. For example, when strip mining a 100x200x300 hyperslab of a simple data space, the buffer must be large enough to hold 1x200x300 data elements. When strip mining a 100x200x300x150 hyperslab of a simple data space, the buffer must be large enough to hold 1x200x300x150 data elements.

Parameters

  plist | Identifier for the dataset transfer property list.
  size | Size, in bytes, of the type conversion and background buffers.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | plist is invalid.

## ◆ H5Pset_cache()

static synchronized native int H5Pset_cache | ( | long | plist,
|  | int | mdc_nelmts,
|  | long | rdcc_nelmts,
|  | long | rdcc_nbytes,
|  | double | rdcc_w0 ) throws HDF5LibraryException
| static

H5Pset_cache sets the number of elements (objects) in the meta data cache and the total number of bytes in the raw data chunk cache.

Parameters

  plist | IN: Identifier of the file access property list.
  mdc_nelmts | IN: No longer used, will be ignored.
  rdcc_nelmts | IN: Number of elements (objects) in the raw data chunk cache.
  rdcc_nbytes | IN: Total size of the raw data chunk cache, in bytes.
  rdcc_w0 | IN: Preemption policy.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_char_encoding()

static synchronized native void H5Pset_char_encoding | ( | long | plist_id,
|  | int | encoding ) throws HDF5LibraryException
| static

H5Pset_char_encoding sets the character encoding of the string.

Parameters

  plist_id | IN: the property list identifier
  encoding | IN: the character encoding of the string

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_chunk() [1/2]

static synchronized native int H5Pset_chunk | ( | long | plist,
|  | int | ndims,
|  | byte[] | dim ) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
| static

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

Parameters

  plist | IN: Identifier for property list to query.
  ndims | IN: The number of dimensions of each chunk.
  dim | IN: An array containing the size of each chunk.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | dims array is null.
  IllegalArgumentException | dims <=0

## ◆ H5Pset_chunk() [2/2]

static synchronized int H5Pset_chunk | ( | long | plist,
|  | int | ndims,
|  | long[] | dim ) throws HDF5Exception, NullPointerException, IllegalArgumentException
| static

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

Parameters

  plist | IN: Identifier for property list to query.
  ndims | IN: The number of dimensions of each chunk.
  dim | IN: An array containing the size of each chunk.

Returns
  a non-negative value if successful

Exceptions

  HDF5Exception | Error from the HDF5 Library.
  NullPointerException | dims array is null.
  IllegalArgumentException | dims <=0

## ◆ H5Pset_chunk_cache()

static synchronized native void H5Pset_chunk_cache | ( | long | dapl_id,
|  | long | rdcc_nslots,
|  | long | rdcc_nbytes,
|  | double | rdcc_w0 ) throws HDF5LibraryException
| static

H5Pset_chunk_cache sets the number of elements (objects) in the meta data cache and the total number of bytes in the raw data chunk cache on a per-datset basis.

Parameters

  dapl_id | IN: Identifier of the dataset access property list.
  rdcc_nslots | IN: Number of elements (objects) in the raw data chunk cache.
  rdcc_nbytes | IN: Total size of the raw data chunk cache, in bytes.
  rdcc_w0 | IN: Preemption policy.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_chunk_opts()

static synchronized native void H5Pset_chunk_opts | ( | long | dcpl_id,
|  | int | opts ) throws HDF5LibraryException
| static

H5Pset_chunk_opts Sets the edge chunk option in a dataset creation property list.

Parameters

  dcpl_id | IN: Dataset creation property list identifier
  opts | IN: Edge chunk option flag. Valid values are: H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS - filters are not applied to partial edge chunks. 0 - Disables option; partial edge chunks will be compressed.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library

## ◆ H5Pset_copy_object()

static synchronized native void H5Pset_copy_object | ( | long | ocp_plist_id,
|  | int | copy_options ) throws HDF5LibraryException
| static

H5Pset_copy_object Sets properties to be used when an object is copied.

Parameters

  ocp_plist_id | IN: Object copy property list identifier
  copy_options | IN: Copy option(s) to be set

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_create_intermediate_group()

static synchronized native int H5Pset_create_intermediate_group | ( | long | lcpl_id,
|  | boolean | crt_intermed_group ) throws HDF5LibraryException
| static

H5Pset_create_intermediate_group specifies in property list whether to create missing intermediate groups

Parameters

  lcpl_id | IN: Link creation property list identifier
  crt_intermed_group | IN: Flag specifying whether to create intermediate groups upon the creation of an object

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_data_transform()

static synchronized native int H5Pset_data_transform | ( | long | plist_id,
|  | String | expression ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_data_transform sets a data transform expression

Parameters

  plist_id | IN: Identifier of the property list or class
  expression | IN: Pointer to the null-terminated data transform expression

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | expression is null.

## ◆ H5Pset_deflate()

static synchronized native int H5Pset_deflate | ( | long | plist,
|  | int | level ) throws HDF5LibraryException
| static

H5Pset_deflate sets the compression method for a dataset.

Parameters

  plist | IN: Identifier for the dataset creation property list.
  level | IN: Compression level.

Returns
  non-negative if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_dset_no_attrs_hint()

static synchronized native void H5Pset_dset_no_attrs_hint | ( | long | dcpl_id,
|  | boolean | minimize ) throws HDF5LibraryException
| static

H5Pset_dset_no_attrs_hint sets the dcpl to minimize (or explicitly to not minimized) dataset object headers upon creation.

Parameters

  dcpl_id | IN: Dataset creation property list
  minimize | IN: the minimize hint setting

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_edc_check()

static synchronized native int H5Pset_edc_check | ( | long | plist,
|  | int | check ) throws HDF5LibraryException
| static

H5Pset_edc_check sets the error-detecting algorithm.

Parameters

  plist | Identifier for the dataset transfer property list.
  check | the error-detecting algorithm to use.

Returns
  non-negative if succeed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_efile_prefix()

static synchronized native void H5Pset_efile_prefix | ( | long | dapl_id,
|  | String | prefix ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_efile_prefix Sets prefix to be applied to external file paths.

Parameters

  dapl_id | IN: Dataset access property list identifier
  prefix | IN: Prefix to be applied to external file paths

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | prefix is null.

## ◆ H5Pset_elink_acc_flags()

static synchronized native int H5Pset_elink_acc_flags | ( | long | lapl_id,
|  | int | flags ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pset_elink_acc_flags Sets the external link traversal file access flag in a link access property list.

Parameters

  lapl_id | IN: Link access property list identifier
  flags | IN: The access flag for external link traversal.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid Flag values.

## ◆ H5Pset_elink_fapl()

static synchronized native int H5Pset_elink_fapl | ( | long | lapl_id,
|  | long | fapl_id ) throws HDF5LibraryException
| static

H5Pset_elink_fapl sets a file access property list for use in accessing a file pointed to by an external link.

Parameters

  lapl_id | IN: Link access property list identifier
  fapl_id | IN: File access property list identifier

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_elink_file_cache_size()

static synchronized native void H5Pset_elink_file_cache_size | ( | long | fapl_id,
|  | int | efc_size ) throws HDF5LibraryException
| static

H5Pset_elink_file_cache_size sets the number of files that can be held open in an external link open file cache.

Parameters

  fapl_id | IN: File access property list identifier
  efc_size | IN: External link open file cache size in number of files.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_elink_prefix()

static synchronized native int H5Pset_elink_prefix | ( | long | lapl_id,
|  | String | prefix ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_elink_prefix Sets prefix to be applied to external link paths.

Parameters

  lapl_id | IN: Link access property list identifier
  prefix | IN: Prefix to be applied to external link paths

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | prefix is null.

## ◆ H5Pset_est_link_info()

static synchronized native int H5Pset_est_link_info | ( | long | gcpl_id,
|  | int | est_num_entries,
|  | int | est_name_len ) throws HDF5LibraryException, IllegalArgumentException
| static

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

Parameters

  gcpl_id | IN: Group creation property list identifier
  est_num_entries | IN: Estimated number of links to be inserted into group
  est_name_len | IN: Estimated average length of link names

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid values to est_num_entries and est_name_len.

## ◆ H5Pset_evict_on_close()

static synchronized native void H5Pset_evict_on_close | ( | long | fapl_id,
|  | boolean | evict_on_close ) throws HDF5LibraryException
| static

H5Pset_evict_on_close controls the library's behavior of evicting metadata associated with a closed object.

Parameters

  fapl_id | IN: File access property list identifier
  evict_on_close | IN: Whether the HDF5 object should be evicted on close.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_external()

static synchronized native int H5Pset_external | ( | long | plist,
|  | String | name,
|  | long | offset,
|  | long | size ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_external adds an external file to the list of external files.

Parameters

  plist | IN: Identifier of a dataset creation property list.
  name | IN: Name of an external file.
  offset | IN: Offset, in bytes, from the beginning of the file to the location in the file where the data starts.
  size | IN: Number of bytes reserved in the file for the data.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | name is null.

## ◆ H5Pset_family_offset()

static synchronized native int H5Pset_family_offset | ( | long | fapl_id,
|  | long | offset ) throws HDF5LibraryException
| static

H5Pset_family_offset sets the offset for family driver.

Parameters

  fapl_id | IN: File access property list identifier
  offset | IN: the offset value

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fapl_core()

static synchronized native int H5Pset_fapl_core | ( | long | fapl_id,
|  | long | increment,
|  | boolean | backing_store ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_fapl_core modifies the file access property list to use the H5FD_CORE driver.

Parameters

  fapl_id | IN: File access property list identifier
  increment | IN: how much to grow the memory each time
  backing_store | IN: write to file name on flush setting

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fapl_direct()

static synchronized native int H5Pset_fapl_direct | ( | long | fapl_id,
|  | long | alignment,
|  | long | block_size,
|  | long | cbuf_size ) throws HDF5LibraryException
| static

H5Pset_fapl_direct Sets up use of the direct I/O driver.

Parameters

  fapl_id | IN: File access property list identifier
  alignment | IN: Required memory alignment boundary
  block_size | IN: File system block size
  cbuf_size | IN: Copy buffer size

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fapl_family()

static synchronized native int H5Pset_fapl_family | ( | long | fapl_id,
|  | long | memb_size,
|  | long | memb_fapl_id ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_fapl_family Sets up use of the direct I/O driver.

Parameters

  fapl_id | IN: File access property list identifier
  memb_size | IN: the size in bytes of each file member (used only when creating a new file)
  memb_fapl_id | IN: the file access property list to be used for each family member

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fapl_hdfs()

static synchronized native int H5Pset_fapl_hdfs | ( | long | fapl_id,
|  | H5FD_hdfs_fapl_t | fapl_conf ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_fapl_hdfs Modify the file access property list to use the H5FD_HDFS driver.

Parameters

  fapl_id | IN: File access property list identifier
  fapl_conf | IN: the properties of the hdfs driver

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fapl_log()

static synchronized native void H5Pset_fapl_log | ( | long | fapl_id,
|  | String | logfile,
|  | long | flags,
|  | long | buf_size ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_fapl_log Sets up the logging virtual file driver (H5FD_LOG) for use. H5Pset_fapl_log modifies the file access property list to use the logging driver, H5FD_LOG. The logging virtual file driver (VFD) is a clone of the standard SEC2 (H5FD_SEC2) driver with additional facilities for logging VFD metrics and activity to a file.

Parameters

  fapl_id | IN: File access property list identifier.
  logfile | IN: logfile is the name of the file in which the logging entries are to be recorded.
  flags | IN: Flags specifying the types of logging activity.
  buf_size | IN: The size of the logging buffers, in bytes.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | logfile is null.

## ◆ H5Pset_fapl_multi()

static synchronized native void H5Pset_fapl_multi | ( | long | fapl_id,
|  | int[] | memb_map,
|  | long[] | memb_fapl,
|  | String[] | memb_name,
|  | long[] | memb_addr,
|  | boolean | relax ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_fapl_multi Sets up use of the multi I/O driver.

Parameters

  fapl_id | IN: File access property list identifier
  memb_map | IN: Maps memory usage types to other memory usage types.
  memb_fapl | IN: Property list for each memory usage type.
  memb_name | IN: Name generator for names of member files.
  memb_addr | IN: The offsets within the virtual address space, from 0 (zero) to HADDR_MAX, at which each type of data storage begins.
  relax | IN: Allows read-only access to incomplete file sets when TRUE.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | an array is null.

## ◆ H5Pset_fapl_ros3()

static synchronized native int H5Pset_fapl_ros3 | ( | long | fapl_id,
|  | H5FD_ros3_fapl_t | fapl_conf ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_fapl_ros3 Modify the file access property list to use the H5FD_ROS3 driver.

Parameters

  fapl_id | IN: File access property list identifier
  fapl_conf | IN: the properties of the ros3 driver

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fapl_sec2()

static synchronized native int H5Pset_fapl_sec2 | ( | long | fapl_id | ) | throws HDF5LibraryException, NullPointerException
| static

H5Pset_fapl_sec2 Sets up use of the sec2 I/O driver.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fapl_split()

static synchronized native void H5Pset_fapl_split | ( | long | fapl_id,
|  | String | meta_ext,
|  | long | meta_plist_id,
|  | String | raw_ext,
|  | long | raw_plist_id ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_fapl_split Sets up use of the split I/O driver. Makes the multi driver act like the old split driver which stored meta data in one file and raw data in another file

Parameters

  fapl_id | IN: File access property list identifier
  meta_ext | IN: meta filename extension
  meta_plist_id | IN: File access property list identifier for metadata
  raw_ext | IN: raw data filename extension
  raw_plist_id | IN: File access property list identifier raw data

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fapl_stdio()

static synchronized native int H5Pset_fapl_stdio | ( | long | fapl_id | ) | throws HDF5LibraryException, NullPointerException
| static

H5Pset_fapl_stdio Sets up use of the stdio I/O driver.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fapl_windows()

static synchronized native int H5Pset_fapl_windows | ( | long | fapl_id | ) | throws HDF5LibraryException, NullPointerException
| static

H5Pset_fapl_windows Sets up use of the windows I/O driver.

Parameters

  fapl_id | IN: File access property list identifier

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fclose_degree()

static synchronized native int H5Pset_fclose_degree | ( | long | fapl_id,
|  | int | degree ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_fclose_degree sets the degree for the file close behavior.

Parameters

  fapl_id | IN File access property list
  degree | IN the degree for the file close behavior

Returns
  non-negative if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_file_locking()

static synchronized native void H5Pset_file_locking | ( | long | fapl_id,
|  | boolean | use_file_locking,
|  | boolean | ignore_when_disabled ) throws HDF5LibraryException
| static

H5Pset_file_locking sets parameters related to file locking.

Parameters

  fapl_id | IN: File access property list identifier
  use_file_locking | IN: Whether the library will use file locking when opening files (mainly for SWMR semantics).
  ignore_when_disabled | IN: Whether file locking will be ignored when disabled on a file system (useful for Lustre).

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_file_space_page_size()

static synchronized native void H5Pset_file_space_page_size | ( | long | fcpl_id,
|  | long | page_size ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pset_file_space_page_size retrieves the file space page size for aggregating small metadata or raw data.

Parameters

  fcpl_id | IN: File creation property list identifier
  page_size | IN: the file space page size.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid values of max_list and min_btree.

## ◆ H5Pset_file_space_strategy()

static synchronized native void H5Pset_file_space_strategy | ( | long | fcpl_id,
|  | int | strategy,
|  | boolean | persist,
|  | long | threshold ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pset_file_space_strategy sets the file space management strategy for the file associated with fcpl_id to strategy. There are four strategies that applications can select and they are described in the Parameters section.

Parameters

  fcpl_id | IN: File creation property list identifier
  strategy | IN: The strategy for file space management. H5F_FSPACE_STRATEGY_FSM_AGGR Mechanisms: free-space managers, aggregators, and virtual file drivers This is the library default when not set. H5F_FSPACE_STRATEGY_PAGE Mechanisms: free-space managers with embedded paged aggregation and virtual file drivers H5F_FSPACE_STRATEGY_AGGR Mechanisms: aggregators and virtual file drivers H5F_FSPACE_STRATEGY_NONE Mechanisms: virtual file drivers
  persist | IN: True to persist free-space.
  threshold | IN: The free-space section threshold. The library default is 1, which is to track all free-space sections. Passing a value of zero (0) indicates that the value of threshold is not to be modified.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid values of max_list and min_btree.

## ◆ H5Pset_fill_time()

static synchronized native int H5Pset_fill_time | ( | long | plist_id,
|  | int | fill_time ) throws HDF5LibraryException
| static

H5Pset_fill_time Sets the fill value writing time.

Parameters

  plist_id | IN: Dataset creation property list identifier.
  fill_time | IN: fill time.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fill_value() [1/2]

static synchronized native int H5Pset_fill_value | ( | long | plist_id,
|  | long | type_id,
|  | byte[] | value ) throws HDF5Exception
| static

H5Pset_fill_value sets the fill value for a dataset creation property list.

Parameters

  plist_id | IN: Property list identifier.
  type_id | IN: The datatype identifier of value.
  value | IN: The fill value.

Returns
  a non-negative value if successful

Exceptions

  HDF5Exception | Error converting data array

## ◆ H5Pset_fill_value() [2/2]

static synchronized int H5Pset_fill_value | ( | long | plist_id,
|  | long | type_id,
|  | Object | obj ) throws HDF5Exception
| static

H5Pset_fill_value sets the fill value for a dataset creation property list.

Parameters

  plist_id | IN: Property list identifier.
  type_id | IN: The datatype identifier of value.
  obj | IN: The fill value.

Returns
  a non-negative value if successful

Exceptions

  HDF5Exception | Error converting data array

## ◆ H5Pset_filter()

static synchronized native int H5Pset_filter | ( | long | plist,
|  | int | filter,
|  | int | flags,
|  | long | cd_nelmts,
|  | int[] | cd_values ) throws HDF5LibraryException
| static

H5Pset_filter adds the specified filter and corresponding properties to the end of an output filter pipeline.

Parameters

  plist | IN: Property list identifier.
  filter | IN: Filter to be added to the pipeline.
  flags | IN: Bit vector specifying certain general properties of the filter.
  cd_nelmts | IN: Number of elements in cd_values
  cd_values | IN: Auxiliary data for the filter.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_fletcher32()

static synchronized native int H5Pset_fletcher32 | ( | long | plist | ) | throws HDF5LibraryException, NullPointerException
| static

H5Pset_fletcher32 sets Fletcher32 checksum of EDC for a dataset creation property list or group creation property list.

Parameters

  plist | IN: Property list identifier.

Returns
  a non-negative value and the size of the user block; if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_gc_references()

static synchronized native int H5Pset_gc_references | ( | long | fapl_id,
|  | boolean | gc_ref ) throws HDF5LibraryException
| static

H5Pset_gc_references Sets the flag for garbage collecting references for the file. Default value for garbage collecting references is off.

Parameters

  fapl_id | IN File access property list
  gc_ref | IN set GC on (true) or off (false)

Returns
  non-negative if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_hyper_vector_size()

static synchronized native int H5Pset_hyper_vector_size | ( | long | dxpl_id,
|  | long | vector_size ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_hyper_vector_size sets the number of "I/O vectors" (offset and length pairs) which are to be accumulated in memory before being issued to the lower levels of the library for reading or writing the actual data. Increasing the number should give better performance, but use more memory during hyperslab I/O. The vector size must be greater than 1.

The default is to use 1024 vectors for I/O during hyperslab reading/writing.

Parameters

  dxpl_id | IN: Dataset transfer property list identifier.
  vector_size | IN: hyper vestor size.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_istore_k()

static synchronized native int H5Pset_istore_k | ( | long | plist,
|  | int | ik ) throws HDF5LibraryException
| static

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

Parameters

  plist | IN: Identifier of property list to query.
  ik | IN: 1/2 rank of chunked storage B-tree.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_layout()

static synchronized native int H5Pset_layout | ( | long | plist,
|  | int | layout ) throws HDF5LibraryException
| static

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

Parameters

  plist | IN: Identifier of property list to query.
  layout | IN: Type of storage layout for raw data.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_libver_bounds()

static synchronized native int H5Pset_libver_bounds | ( | long | fapl_id,
|  | int | low,
|  | int | high ) throws HDF5LibraryException, IllegalArgumentException
| static

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

Parameters

  fapl_id | IN: File access property list identifier
  low | IN: The earliest version of the library that will be used for writing objects
  high | IN: The latest version of the library that will be used for writing objects.

Returns
  Returns a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Argument is Illegal

## ◆ H5Pset_link_creation_order()

static synchronized native int H5Pset_link_creation_order | ( | long | gcpl_id,
|  | int | crt_order_flags ) throws HDF5LibraryException
| static

H5Pset_link_creation_order Sets flags in a group creation property list, gcpl_id, for tracking and/or indexing links on creation order.

Parameters

  gcpl_id | IN: Group creation property list identifier
  crt_order_flags | IN: Creation order flag(s)

Returns
  Returns a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_link_phase_change()

static synchronized native int H5Pset_link_phase_change | ( | long | gcpl_id,
|  | int | max_compact,
|  | int | min_dense ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pset_link_phase_change Sets the parameters for conversion between compact and dense groups.

Parameters

  gcpl_id | IN: Group creation property list identifier
  max_compact | IN: Maximum number of links for compact storage(Default: 8)
  min_dense | IN: Minimum number of links for dense storage(Default: 6)

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid values of max_compact and min_dense.

## ◆ H5Pset_local_heap_size_hint()

static synchronized native int H5Pset_local_heap_size_hint | ( | long | gcpl_id,
|  | long | size_hint ) throws HDF5LibraryException
| static

H5Pset_local_heap_size_hint Specifies the anticipated maximum size of a local heap.

Parameters

  gcpl_id | IN: Group creation property list identifier
  size_hint | IN: Anticipated maximum size in bytes of local heap

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_mdc_config()

static synchronized native void H5Pset_mdc_config | ( | long | plist_id,
|  | H5AC_cache_config_t | config_ptr ) throws HDF5LibraryException
| static

H5Pset_mdc_config sets the initial metadata cache configuration contained in a file access property list and loads it into the instance of H5AC_cache_config_t pointed to by the config_ptr parameter. This configuration is used when the file is opened.

Parameters

  plist_id | IN: Identifier of the file access property list.
  config_ptr | IN: H5AC_cache_config_t, the initial metadata cache configuration.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_mdc_log_options()

static synchronized native void H5Pset_mdc_log_options | ( | long | fapl_id,
|  | boolean | is_enabled,
|  | String | location,
|  | boolean | start_on_access ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_mdc_log_options sets metadata cache logging options.

Parameters

  fapl_id | IN: File access property list identifier
  is_enabled | IN: Whether logging is enabled.
  location | IN: Location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII).
  start_on_access | IN: Whether the logging begins as soon as the file is opened or created.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | location is null.

## ◆ H5Pset_meta_block_size()

static synchronized native void H5Pset_meta_block_size | ( | long | fapl_id,
|  | long | size ) throws HDF5LibraryException
| static

H5Pset_meta_block_size sets the minimum metadata block size.

Parameters

  fapl_id | IN: File access property list identifier
  size | IN: Minimum size, in bytes, of metadata block allocations.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_metadata_read_attempts()

static synchronized native void H5Pset_metadata_read_attempts | ( | long | plist_id,
|  | long | attempts ) throws HDF5LibraryException
| static

H5Pset_metadata_read_attempts sets the number of reads that the library will try when reading checksummed metadata in an HDF5 file opened with SWMR access. When reading such metadata, the library will compare the checksum computed for the metadata just read with the checksum stored within the piece of checksum. When performing SWMR operations on a file, the checksum check might fail when the library reads data on a system that is not atomic. To remedy such situations, the library will repeatedly read the piece of metadata until the check passes or finally fails the read when the allowed number of attempts is reached.

Parameters

  plist_id | IN: File access property list identifier
  attempts | IN: The number of read attempts which is a value greater than 0.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_nbit()

static synchronized native int H5Pset_nbit | ( | long | plist_id | ) | throws HDF5LibraryException
| static

H5Pset_nbit Sets up the use of the N-Bit filter.

Parameters

  plist_id | IN: Dataset creation property list identifier.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_nlinks()

static synchronized native int H5Pset_nlinks | ( | long | lapl_id,
|  | long | nlinks ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pset_nlinks sets the maximum number of soft or user-defined link traversals allowed, nlinks, before the library assumes it has found a cycle and aborts the traversal. This value is set in the link access property list lapl_id.

Parameters

  lapl_id | IN: File access property list identifier
  nlinks | IN: Maximum number of links to traverse

Returns
  Returns a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Argument is Illegal

## ◆ H5Pset_obj_track_times()

static synchronized native void H5Pset_obj_track_times | ( | long | ocpl_id,
|  | boolean | track_times ) throws HDF5LibraryException
| static

H5Pset_obj_track_times sets a property in the object creation property list, ocpl_id, that governs the recording of times associated with an object.

Parameters

  ocpl_id | IN: Object creation property list identifier
  track_times | IN: TRUE or FALSE, specifying whether object times are to be tracked

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_scaleoffset()

static synchronized native int H5Pset_scaleoffset | ( | long | plist_id,
|  | int | scale_type,
|  | int | scale_factor ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pset_scaleoffset sets the Scale-Offset filter for a dataset.

Parameters

  plist_id | IN: Dataset creation property list identifier.
  scale_type | IN: Flag indicating compression method.
  scale_factor | IN: Parameter related to scale.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid arguments

## ◆ H5Pset_shared_mesg_index()

static synchronized native int H5Pset_shared_mesg_index | ( | long | fcpl_id,
|  | int | index_num,
|  | int | mesg_type_flags,
|  | int | min_mesg_size ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pset_shared_mesg_index Configures the specified shared object header message index

Parameters

  fcpl_id | IN: File creation property list identifier.
  index_num | IN: Index being configured.
  mesg_type_flags | IN: Types of messages that should be stored in this index.
  min_mesg_size | IN: Minimum message size.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid value of nindexes

## ◆ H5Pset_shared_mesg_nindexes()

static synchronized native int H5Pset_shared_mesg_nindexes | ( | long | plist_id,
|  | int | nindexes ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pset_shared_mesg_nindexes sets the number of shared object header message indexes in the specified file creation property list.

Parameters

  plist_id | IN: File creation property list
  nindexes | IN: Number of shared object header message indexes to be available in files created with this property list

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid value of nindexes

## ◆ H5Pset_shared_mesg_phase_change()

static synchronized native int H5Pset_shared_mesg_phase_change | ( | long | fcpl_id,
|  | int | max_list,
|  | int | min_btree ) throws HDF5LibraryException, IllegalArgumentException
| static

H5Pset_shared_mesg_phase_change sets shared object header message storage phase change thresholds.

Parameters

  fcpl_id | IN: File creation property list identifier
  max_list | IN: Threshold above which storage of a shared object header message index shifts from list to B-tree
  min_btree | IN: Threshold below which storage of a shared object header message index reverts to list format

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  IllegalArgumentException | Invalid values of max_list and min_btree.

## ◆ H5Pset_shuffle()

static synchronized native int H5Pset_shuffle | ( | long | plist_id | ) | throws HDF5LibraryException, NullPointerException
| static

H5Pset_shuffle Sets up the use of the shuffle filter.

Parameters

  plist_id | IN: Dataset creation property list identifier.

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_sieve_buf_size()

static synchronized native void H5Pset_sieve_buf_size | ( | long | fapl_id,
|  | long | size ) throws HDF5LibraryException
| static

H5Pset_sieve_buf_size Sets the maximum size of the data sieve buffer used for file drivers which are capable of using data sieving. The data sieve buffer is used when performing I/O on datasets in the file. Using a buffer which is large enough to hold several pieces of the dataset being read in for hyperslab selections boosts performance by quite a bit.

The default value is set to 64KB, indicating that file I/O for raw data reads and writes will occur in at least 64KB blocks. Setting the value to 0 with this function will turn off the data sieving

Parameters

  fapl_id | IN: Identifier of property list to modify.
  size | IN: maximum size of the data sieve buffer.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_sizes()

static synchronized native int H5Pset_sizes | ( | long | plist,
|  | int | sizeof_addr,
|  | int | sizeof_size ) throws HDF5LibraryException
| static

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

Parameters

  plist | IN: Identifier of property list to modify.
  sizeof_addr | IN: Size of an object offset in bytes.
  sizeof_size | IN: Size of an object length in bytes.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_small_data_block_size()

static synchronized native int H5Pset_small_data_block_size | ( | long | plist,
|  | long | size ) throws HDF5LibraryException
| static

H5Pset_small_data_block_size reserves blocks of size bytes for the contiguous storage of the raw data portion of small datasets.

Parameters

  plist | IN: Identifier of property list to modify.
  size | IN: Size of the blocks in bytes.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_sym_k()

static synchronized native int H5Pset_sym_k | ( | long | plist,
|  | int | ik,
|  | int | lk ) throws HDF5LibraryException
| static

H5Pset_sym_k sets the size of parameters used to control the symbol table nodes.

Parameters

  plist | IN: Identifier for property list to query.
  ik | IN: Symbol table tree rank.
  lk | IN: Symbol table node size.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_szip()

static synchronized native int H5Pset_szip | ( | long | plist,
|  | int | options_mask,
|  | int | pixels_per_block ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_szip Sets up the use of the szip filter.

Parameters

  plist | IN: Dataset creation property list identifier.
  options_mask | IN: Bit vector specifying certain general properties of the filter.
  pixels_per_block | IN: Number of pixels in blocks

Returns
  a non-negative value if successful; otherwise returns a negative value.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_userblock()

static synchronized native int H5Pset_userblock | ( | long | plist,
|  | long | size ) throws HDF5LibraryException
| static

H5Pset_userblock sets the user block size of a file creation property list.

Parameters

  plist | IN: Identifier of property list to modify.
  size | IN: Size of the user-block in bytes.

Returns
  a non-negative value if successful

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_virtual()

static synchronized native void H5Pset_virtual | ( | long | dcpl_id,
|  | long | vspace_id,
|  | String | src_file_name,
|  | String | src_dset_name,
|  | long | src_space_id ) throws HDF5LibraryException, NullPointerException, IllegalArgumentException
| static

H5Pset_virtual maps elements of the virtual dataset (VDS) described by the virtual dataspace identifier vspace_id to the elements of the source dataset described by the source dataset dataspace identifier src_space_id. The source dataset is identified by the name of the file where it is located, src_file_name, and the name of the dataset, src_dset_name.

Parameters

  dcpl_id | IN: The identifier of the dataset creation property list that will be used when creating the virtual dataset.
  vspace_id | IN: The dataspace identifier with the selection within the virtual dataset applied, possibly an unlimited selection.
  src_file_name | IN: The name of the HDF5 file where the source dataset is located. The file might not exist yet. The name can be specified using a C-style printf statement.
  src_dset_name | IN: The path to the HDF5 dataset in the file specified by src_file_name. The dataset might not exist yet. The dataset name can be specified using a C-style printf statement.
  src_space_id | IN: The source dataset dataspace identifier with a selection applied, possibly an unlimited selection.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | an name string is null.
  IllegalArgumentException | an id is <=0

## ◆ H5Pset_virtual_prefix()

static synchronized native void H5Pset_virtual_prefix | ( | long | dapl_id,
|  | String | prefix ) throws HDF5LibraryException, NullPointerException
| static

H5Pset_virtual_prefix Sets prefix to be applied to virtual file paths.

Parameters

  dapl_id | IN: Dataset access property list identifier
  prefix | IN: Prefix to be applied to virtual file paths

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.
  NullPointerException | prefix is null.

## ◆ H5Pset_virtual_printf_gap()

static synchronized native void H5Pset_virtual_printf_gap | ( | long | dapl_id,
|  | long | gap_size ) throws HDF5LibraryException
| static

H5Pset_virtual_printf_gap sets the access property list for the virtual dataset, dapl_id, to instruct the library to stop looking for the mapped data stored in the files and/or datasets with the printf-style names after not finding gap_size files and/or datasets. The found source files and datasets will determine the extent of the unlimited virtual dataset with the printf-style mappings.

Parameters

  dapl_id | IN: Dataset access property list identifier for the virtual dataset
  gap_size | IN: Maximum number of files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library

## ◆ H5Pset_virtual_spatial_tree()

static synchronized native void H5Pset_virtual_spatial_tree | ( | long | dapl_id,
|  | boolean | use_tree ) throws HDF5LibraryException
| static

H5Pset_virtual_spatial_tree sets the dapl to use/not use a spatial tree during mapping operations on a Virtual Dataset. The default value is true.

Use of a spatial tree will accelerate the process of searching through mappings to determine which contain intersections with the user's selection region. With the tree disabled, all mappings will simply be iterated through and checked directly.

Certain workflows may find that tree creation overhead outweighs the time saved on reads. In this case, disabling this property will lead to a performance improvement, though it is expected that almost all cases will benefit from the tree on net.

Parameters

  dapl_id | IN: Dataset access property list
  use_tree | IN: the use_tree flag setting

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.

## ◆ H5Pset_virtual_view()

static synchronized native void H5Pset_virtual_view | ( | long | dapl_id,
|  | int | view ) throws HDF5LibraryException
| static

H5Pset_virtual_view takes the access property list for the virtual dataset, dapl_id, and the flag, view, and sets the VDS view according to the flag value.

Parameters

  dapl_id | IN: Dataset access property list identifier for the virtual dataset
  view | IN: Flag specifying the extent of the data to be included in the view.

Exceptions

  HDF5LibraryException | Error from the HDF5 Library

## ◆ H5Punregister()

static synchronized native int H5Punregister | ( | long | plid,
|  | String | name ) throws HDF5LibraryException
| static

H5Punregister removes a property from a property list class

Parameters

  plid | IN: Property list class from which to remove permanent property
  name | IN: Name of property to remove

Returns
  a non-negative value if successful; a negative value if failed

Exceptions

  HDF5LibraryException | Error from the HDF5 Library.