Last modified: 22 April 2016
Name: H5Pset_virtual_printf_gap
Signature:
  `herr_t H5Pset_virtual_printf_gap( hid_t dapl_id, hsize_t gap_size )`
Purpose:
  Sets the maximum number of missing source files and/or datasets with the printf-style names when getting the extent of an unlimited virtual dataset.
Description:
  `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.

  Consider the following examples where the regularly spaced blocks of a virtual dataset are mapped to datasets with the names `d-1`, `d-2`, `d-3`, ..., `d-N`, ... :
  - If the dataset `d-2` is missing and `gap_size` is set to `0`, then the virtual dataset will contain only data found in `d-1`.
  - If `d-2` and `d-3` are missing and `gap_size` is set to `2`, then the virtual dataset will contain the data from `d-1`, `d-3`, ..., `d-N`, ... . The blocks that are mapped to `d-2` and `d-3` will be filled according to the virtual dataset’s fill value setting.
Parameters:

  `hid_t dapl_id` | `` | IN: Dataset access property list identifier for the virtual dataset
  `hsize_t 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 (Default value: `0`)

Returns:
  Returns a non-negative value if successful; otherwise returns a negative value.
Fortran Interface: h5pset_virtual_printf_gap_f
See Also:

  “Virtual Dataset Overview” “Using HDF5 Virtual Datasets” Supporting functions: H5Pset_layout H5Pget_layout H5Sis_regular_hyperslab H5Sget_regular_hyperslab H5Sselect_hyperslab | VDS functions: H5Pset_virtual H5Pget_virtual_count H5Pget_virtual_vspace H5Pget_virtual_srcspace H5Pget_virtual_filename H5Pget_virtual_dsetname H5Pget_virtual_printf_gap H5Pset_virtual_view H5Pget_virtual_view

History:

  Release | Change
  1.10.0 | C function introduced with this release.