Fortran Interface: h5pget_virtual_filename_f
SUBROUTINE h5pget_virtual_filename_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
name_len - The size of name needed to hold the filename. (OUT)
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.
name - A buffer containing the name of the file containing the
hdferr - Returns 0 if successful and -1 if fails.
IN: The identifier of the virtual dataset creation property list
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 H5P_GET_VIRTUAL_COUNT.
OUT: A buffer containing the name of the file containing the source dataset
IN: The size, in bytes, of the name buffer. Must be the size of the filename in bytes plus 1 for a NULL terminator
H5P_GET_VIRTUAL_FILENAME takes the dataset creation property list for the virtual dataset, dcpl_id, the mapping index, index, the size of the filename for a source dataset, size, and retrieves the name of the file for a source dataset used in the mapping.
Up to size characters of the filename are returned in name; additional characters, if any, are not returned to the user application.
If the length of the filename, which determines the required value of size, is unknown, a preliminary call to H5P_GET_VIRTUAL_FILENAME 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 filename. That value, plus 1 for a NULL terminator, must then be assigned to size for a second H5P_GET_VIRTUAL_FILENAME call, which will retrieve the actual filename.
Returns the length of the filename if successful; otherwise returns a negative value.