Last modified: 18 March 2016

Name: H5Pget_virtual_printf_gap

Signature:
herr_t H5Pget_virtual_printf_gap( hid_t dapl_id, hsize_t *gap_size )

Purpose:
Returns the maximum number of missing source files and/or datasets with the printf-style names when getting the extent for an unlimited virtual dataset.

Description:
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.

The default library value for gap_size is 0 (zero).


Parameters:
hid_t dapl_id   IN: Dataset access property list identifier for the virtual dataset
hsize_t *gap_size   OUT: Maximum number of the files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings.
(Default: 0)

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

Fortran Interface: h5pget_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
  • H5Pset_virtual_printf_gap
  • H5Pset_virtual_view
  • H5Pget_virtual_view

  • History:
    Release     Change
    1.10.0 C function introduced with this release.