H5P_SET_VIRTUAL_PRINTF_GAP
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
Procedure:
H5P_SET_VIRTUAL_PRINTF_GAP ( dapl_id, gap_size )
Signature:
herr_t H5Pset_virtual_printf_gap(
hid_t dapl_id,
hsize_t gap_size
)
Fortran Interface: h5pset_virtual_printf_gap_f
Signature:
SUBROUTINE h5pset_virtual_printf_gap_f(dapl_id, gap_size, hdferr)
INTEGER(HID_T) , INTENT(IN) :: dapl_id
INTEGER(HSIZE_T), INTENT(IN) :: gap_size
INTEGER , INTENT(OUT) :: hdferr
Inputs:
dapl_id - Dataset access property list identifier for the virtual dataset.
gap_size - Maximum number of files and/or datasets allowed to be missing
for determining the extent of an unlimited virtual dataset
with printf-style mappings.
Outputs:
hdferr - Returns 0 if successful and -1 if fails.
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) |
Description:
H5P_SET_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.
See Also:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.10.0 | C function introduced with this release. |
--- Last Modified: August 08, 2019 | 02:55 PM
