diff options
author | Dana Robinson <derobins@hdfgroup.org> | 2021-05-05 02:01:23 (GMT) |
---|---|---|
committer | Dana Robinson <derobins@hdfgroup.org> | 2021-05-05 02:01:23 (GMT) |
commit | 8e27e7357506958128d087c4e93e3dcb4fb52ace (patch) | |
tree | aacca527aede81daddad6707c2f9346fc933a773 /src/H5FDwindows.h | |
parent | 16eda679e306fde7fec41f5ff1910be86645e745 (diff) | |
download | hdf5-8e27e7357506958128d087c4e93e3dcb4fb52ace.zip hdf5-8e27e7357506958128d087c4e93e3dcb4fb52ace.tar.gz hdf5-8e27e7357506958128d087c4e93e3dcb4fb52ace.tar.bz2 |
Brings atom-->ID and other ID-related changes from develop
Diffstat (limited to 'src/H5FDwindows.h')
-rw-r--r-- | src/H5FDwindows.h | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/src/H5FDwindows.h b/src/H5FDwindows.h index c1c4654..79e73b6 100644 --- a/src/H5FDwindows.h +++ b/src/H5FDwindows.h @@ -27,6 +27,36 @@ extern "C" { #endif /* __cplusplus */ +/** + * \ingroup FAPL + * + * \brief Sets the Windows I/O driver + * + * \fapl_id + * \returns \herr_t + * + * \details H5Pset_fapl_windows() sets the default HDF5 Windows I/O driver on + * Windows systems. + * + * Since the HDF5 library uses this driver, #H5FD_WINDOWS, by default + * on Windows systems, it is not normally necessary for a user + * application to call H5Pset_fapl_windows(). While it is not + * recommended, there may be times when a user chooses to set a + * different HDF5 driver, such as the standard I/O driver (#H5FD_STDIO) + * or the sec2 driver (#H5FD_SEC2), in a Windows + * application. H5Pset_fapl_windows() is provided so that the + * application can return to the Windows I/O driver when the time + * comes. + * + * Only the Windows driver is tested on Windows systems; other drivers + * are used at the application’s and the user’s risk. + * + * Furthermore, the Windows driver is tested and available only on + * Windows systems; it is not available on non-Windows systems. + * + * \since 1.8.0 + * + */ H5_DLL herr_t H5Pset_fapl_windows(hid_t fapl_id); #ifdef __cplusplus |