Last modified: 22 April 2016
Name: H5Pget_virtual_dsetname
Signature:
  `ssize_t H5Pget_virtual_dsetname( hid_t dcpl_id, size_t index, char *name, size_t size )`
Purpose:
  Gets the name of a source dataset used in the mapping.
Description:
  `H5Pget_virtual_dsetname` takes the dataset creation property list for the virtual dataset, `dcpl_id`, the mapping index, `index`, the size of the dataset name for a source dataset, `size`, and retrieves the name of the source dataset used in the mapping.

  Up to `size` characters of the dataset name are returned in `name`; additional characters, if any, are not returned to the user application.

  If the length of the dataset name, which determines the required value of `size`, is unknown, a preliminary call to `H5Pget_virtual_dsetname` with the last two parameters set to `NULL` and zero respectively can be made. The return value of this call will be the size in bytes of the dataset name. That value, plus 1 for a `NULL` terminator, must then be assigned to `size` for a second `H5Pget_virtual_dsetname` call, which will retrieve the actual dataset name.

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`.
  `char *name` | `` | OUT: A buffer containing the name of the source dataset.
  `size_t size` | `` | IN: The size, in bytes, of the name buffer. Must be the size of the dataset name in bytes plus 1 for a `NULL` terminator.

Returns:
  Returns the length of the dataset name if successful; otherwise returns a negative value.
Fortran Interface: h5pget_virtual_dsetname_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 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.