Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_GET_VIRTUAL_DSETNAME

Gets the name of a source dataset used in the mapping

Procedure:

H5P_GET_VIRTUAL_DSETNAME ( dcpl_id, index, name, size )

Signature:

ssize_t H5Pget_virtual_dsetname(
        hid_t dcpl_id,
        size_t index,
        char *name,
        size_t size
        )
    

Fortran Interface: h5pget_virtual_dsetname_f
 
Signature:
  SUBROUTINE h5pget_virtual_dsetname_f(dcpl_id, index, name, hdferr, name_len)
    INTEGER(HID_T)  , INTENT(IN)  :: dcpl_id
    INTEGER(SIZE_T) , INTENT(IN)  :: index
    CHARACTER(LEN=*), INTENT(OUT) :: name
    INTEGER, INTENT(OUT)          :: hdferr
    INTEGER(SIZE_T), OPTIONAL     :: name_len

Optional parameters:
  name_len - The size of name needed to hold the source dataset name. (OUT)

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:
  name   - A buffer containing the name of the source dataset.
  hdferr - Returns 0 if successful and -1 if fails.
        

Parameters:
hid_t dcpl_idIN: The identifier of the virtual dataset creation property list
size_t indexIN: 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 *nameOUT: A buffer containing the name of the source dataset
size_t sizeIN: The size, in bytes, of the name buffer
Must be the size of the dataset name in bytes plus 1 for a NULL terminator

Description:

H5P_GET_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 H5P_GET_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 H5P_GET_VIRTUAL_DSETNAME call, which will retrieve the actual dataset name.

Returns:

Returns the length of the dataset name if successful; otherwise returns a negative value.

Example:

Coming Soon!

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

--- Last Modified: January 02, 2018 | 03:20 PM