Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_GET_VIRTUAL_PREFIX

Retrieves prefix applied to VDS source file paths

Procedure:

H5P_GET_VIRTUAL_PREFIX ( dapl_id, prefix, size )

Signature:

ssize_t H5Pget_virtual_prefix(
        hid_t dapl_id,
        char *prefix,
        size_t size
    )
  

NONE

Parameters:
hid_t dapl_idIN: Dataset access property list identifier
char *prefix    OUT: Prefix applied to VDS source file paths
size_t sizeIN: Size of prefix, including null terminator

Description:

H5P_GET_VIRTUAL_PREFIX retrieves the prefix applied to the path of any VDS source files traversed.

When an VDS source file is traversed, the prefix is retrieved from the dataset access property list dapl_id, returned in the user-allocated buffer pointed to by prefix, and prepended to the filename stored in the VDS virtual file, set with H5P_SET_VIRTUAL.

The size in bytes of the prefix, including the NULL terminator, is specified in size. If size is unknown, a preliminary H5P_GET_VIRTUAL_PREFIX call with the pointer prefix set to NULL will return the size of the prefix without the NULL terminator.

Returns:

If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL terminator; otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    C
1.10.2Function introduced in this release.

--- Last Modified: March 22, 2018 | 11:22 AM