Last modified: 18 March 2016

Name: H5Pget_virtual_srcspace

Signature:
hid_t H5Pget_virtual_srcspace( hid_t dcpl_id, size_t index )

Purpose:
Gets a dataspace identifier for the selection within the source dataset used in the mapping.

Description:
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:
hid_t dcpl_id   IN: The identifier of the virtual dataset creation property list.
size_t index   IN: Mapping index.
The value of index is 0 (zero) or greater and less than count   (0 ≤ index < count), where count is the number of mappings returned by H5Pget_virtual_count.

Returns:
Returns a valid dataspace identifier if successful; otherwise returns a negative value.

Fortran Interface: h5pget_virtual_srcspace_f
Signature:
  SUBROUTINE h5pget_virtual_srcspace_f(dcpl_id, index, ds_id, hdferr)
    INTEGER(HID_T) , INTENT(IN)  :: dcpl_id
    INTEGER(SIZE_T), INTENT(IN)  :: index
    INTEGER(HID_T) , INTENT(OUT) :: ds_id
    INTEGER, INTENT(OUT)         :: hdferr
Inputs:
  dcpl_id - The identifier of the virtual dataset creation property list.
  index   - Mapping index.
            The value of index is 0 (zero) or greater and less than count 
            (0 ≤ index < count), where count is the number of mappings 
            returned by h5pget_virtual_count.
Outputs:
  ds_id  - dataspace identifier
  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_filename
  • H5Pget_virtual_dsetname
  • H5Pset_virtual_printf_gap
  • H5Pget_virtual_printf_gap
  • H5Pset_virtual_view
  • H5Pget_virtual_view

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