Last modified: 18 March 2016

Name: H5Pset_virtual_view

Signature:
herr_t H5Pset_virtual_view( hid_t dapl_id, H5D_vds_view_t view )

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

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

If view is set to H5D_VDS_FIRST_MISSING, the view includes all data before the first missing mapped data. This setting provides a view containing only the continuous data starting with the dataset’s first data element. Any break in continuity terminates the view.

If view is set to H5D_VDS_LAST_AVAILABLE, the view includes all available mapped data.

Missing mapped data is filled with the fill value set in the VDS creation property list.


Parameters:
hid_t dapl_id   IN: Identifier of the virtual dataset access property list.
H5D_vds_view_t view   IN: Flag specifying the extent of the data to be included in the view.
Valid values are:
H5D_VDS_FIRST_MISSING 
     View includes all data before the first missing mapped data.
H5D_VDS_LAST_AVAILABLE 
  View includes all available mapped data.

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

Fortran Interface: h5pset_virtual_view_f
Signature:
  SUBROUTINE h5pset_virtual_view_f(dapl_id, view, hdferr)
    INTEGER(HID_T), INTENT(IN)  :: dapl_id
    INTEGER       , INTENT(IN)  :: view
    INTEGER       , INTENT(OUT) :: hdferr
Inputs:
  dapl_id - Identifier of the virtual dataset access property list.
  view    - Flag specifying the extent of the data to be included in the view.
            Valid values are:
               H5D_VDS_FIRST_MISSING_F
               H5D_VDS_LAST_AVAILABLE_F
Outputs:
  hdferr   - Returns 0 if successful and -1 if fails.

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
  • H5Pget_virtual_printf_gap
  • H5Pget_virtual_view

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