- Created by Barbara Jones, last modified on May 27, 2020
H5P_GET_DRIVER
Returns low-lever driver identifier
Procedure:
H5P_GET_DRIVER ( plist_id )
Signature:
hid_t H5Pget_driver(
hid_t plist_id
)
Fortran90 Interface: h5pget_driver_f
SUBROUTINE h5pget_driver_f(prp_id, driver, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
INTEGER(HID_T), INTENT(OUT) :: driver ! Low-level file driver identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5pget_driver_f
Parameters:
hid_t plist_id IN: File access or data transfer property list identifier
Description:
H5P_GET_DRIVER returns the identifier of the low-level file driver associated with the file access property list or data transfer property list plist_id.
Valid driver identifiers distributed with HDF5 are listed and described in the following table.
Supported file drivers in HDF5
Driver Name | Driver Identifier | Description | Related API |
|---|---|---|---|
| POSIX | H5FD_SEC2 | This driver uses POSIX file-system functions like read and write to perform I/O to a single, permanent file on local disk with no system buffering. This driver is POSIX-compliant and is the default file driver for all systems. | H5Pset_fapl_sec2 |
| Direct | H5FD_DIRECT | This is the H5FD_SEC2 driver except data is written to or read from the file synchronously without being cached by the system. | H5Pset_fapl_direct |
| Log | H5FD_LOG | This is the H5FD_SEC2 driver with logging capabilities. | H5Pset_fapl_log |
| Windows | H5FD_WINDOWS | This driver was modified in HDF5-1.8.8 to be a wrapper of the POSIX driver, H5FD_SEC2. This change should not affect user applications. | H5Pset_fapl_windows |
| STDIO | H5FD_STDIO | This driver uses functions from the standard C stdio.h to perform I/O to a single, permanent file on local disk with additional system buffering. | H5Pset_fapl_stdio |
| Memory | H5FD_CORE | With this driver, an application can work with a file in memory for faster reads and writes. File contents are kept in memory until the file is closed. At closing, the memory version of the file can be written back to disk or abandoned. | H5Pset_fapl_core |
| Family | H5FD_FAMILY | With this driver, the HDF5 file’s address space is partitioned into pieces and sent to separate storage files using an underlying driver of the user’s choice. This driver is for systems that do not support files larger than 2 gigabytes. | H5Pset_fapl_family |
| Multi | H5FD_MULTI | With this driver, data can be stored in multiple files according to the type of the data. I/O might work better if data is stored in separate files based on the type of data. The Split driver is a special case of this driver. | H5Pset_fapl_multi |
| Parallel | H5FD_MPIO | This is the standard HDF5 file driver for parallel file systems. This driver uses the MPI standard for both communication and file I/O. | H5Pset_fapl_mpio |
| Parallel POSIX | H5FD_MPIPOSIX | This driver is no longer available. | |
| Stream | H5FD_STREAM | This driver is no longer available. |
This list does not include custom drivers that might be defined and registered by a user.
The returned driver identifier is only valid as long as the file driver remains registered.
Returns:
Returns a valid low-level driver identifier if successful. Otherwise returns a negative value.
Example:
Coming Soon!
History:
| Release | Change |
|---|---|
| 1.4.0 | Function introduced in this release. |
--- Last Modified: May 27, 2020 | 03:50 PM