Retrieves the prefix for external raw data storage files as set in the dataset access property list
Procedure:
H5P_GET_EFILE_PREFIX ( dapl_id, prefix, size )
Signature:
ssize_t H5Pget_efile_prefix(
hid_t dapl_id,
const char *prefix,
size_t size
)
Parameters:
hid_t
dapl_id | IN: Dataset access property list identifier |
const char *prefix | IN/OUT: Dataset external storage prefix in UTF-8 or ASCII (Path and filename must be ASCII on Windows systems.) |
size_t
size | IN: Size of prefix buffer in bytes |
Description:
H5P_GET_EFILE_PREFIX retrieves the file system path prefix for locating external files associated with a dataset that uses external storage. This will be the value set with H5P_SET_EFILE_PREFIX or the HDF5 library’s default.
The value of size
is the size in bytes of the prefix, including the NULL
terminator. If the size is unknown, a preliminary H5P_GET_ELINK_PREFIX call with the pointer prefix
set to NULL
will return the size of the prefix without the NULL
terminator.
The prefix
buffer must be allocated by the caller. In a call that retrieves the actual prefix, that buffer must be of the size specified in size
.
Returns:
Returns the size of prefix
and the prefix string will be stored in prefix
if successful.
Otherwise returns a negative value and the contents of prefix
will be undefined.
Example:
History:
Release | Change |
---|
1.10.0 and 1.8.17 | C function introduced in these releases. |
--- Last Modified: August 08, 2019 | 11:14 AM