Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Gets the filename of a source dataset used in the mapping

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5P_GET_VIRTUAL_FILENAME ( dcpl_id, index, name, size )

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">ssize_t H5Pget_virtual_filename(
        hid_t dcpl_id,
        size_t index,
        char *name,
        size_t size
        )
    </code></pre>
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">Fortran Interface: h5pget_virtual_filename_f

Signature:
  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

Optional parameters:
  name_len - The size of name needed to hold the filename. (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 file containing the 
           source dataset.
  hdferr - Returns 0 if successful and -1 if fails.
        </code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
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 H5P_GET_VIRTUAL_COUNT.
char *nameOUT: A buffer containing the name of the file containing the source dataset

.

size_t sizeIN: The size, in bytes, of the name buffer.
Must be the size of the filename in bytes plus 1 for a NULL terminator

.

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

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.

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

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

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Coming Soon!

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
Release    Change
1.10.0C function introduced with this release.