Returns pointer to the file handle from the virtual file driver
Procedure:
H5F_GET_VFD_HANDLE (file_id, fapl_id, file_handle)
Signature:
herr_t H5Fget_vfd_handle(hid_t file_id, hid_t fapl_id, void **file_handle )
Parameters:
hid_t file_id | IN: Identifier of the file to be queried |
hid_t fapl_id | IN: File access property list identifier. For most drivers, the value will be H5P_DEFAULT. For the FAMILY or MULTI drivers, this value should be defined through the property list functions: H5P_SET_FAMILY_OFFSET for the FAMILY driver and H5P_SET_MULTI_TYPE for the MULTI driver |
void **file_handle | OUT: Pointer to the file handle being used by the low-level virtual file driver |
Description:
Given the file identifier file_id and the file access property list fapl_id, H5F_GET_VFD_HANDLE returns a pointer to the file handle from the low-level file driver currently being used by the HDF5 library for file I/O.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.6.0 | Function introduced in this release. |
--- Last Modified: December 20, 2018 | 11:32 AM
