diff options
| author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2022-12-28 21:07:39 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-12-28 21:07:39 (GMT) |
| commit | 3da2551adb7f5a290839e062085fdfb471864d76 (patch) | |
| tree | 691f5f6cca05b5d0f4c02f7fa258d9970abfb7ee /src/H5FDpublic.h | |
| parent | d261272ffa869af41ce1b60b741e90b3f8c1075b (diff) | |
| download | hdf5-3da2551adb7f5a290839e062085fdfb471864d76.zip hdf5-3da2551adb7f5a290839e062085fdfb471864d76.tar.gz hdf5-3da2551adb7f5a290839e062085fdfb471864d76.tar.bz2 | |
Adds Doxygen markup for H5FDdriver_query() (#2376)
Diffstat (limited to 'src/H5FDpublic.h')
| -rw-r--r-- | src/H5FDpublic.h | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/src/H5FDpublic.h b/src/H5FDpublic.h index 3b956de..422cd18 100644 --- a/src/H5FDpublic.h +++ b/src/H5FDpublic.h @@ -397,7 +397,27 @@ extern "C" { #endif /* Function prototypes */ -/* Allows querying a VFD ID for features before the file is opened */ + +/** + * \ingroup H5FD + * + * \brief Allows querying a VFD ID for features before the file is opened + * + * \param[in] driver_id Virtual File Driver (VFD) ID + * \param[out] flags VFD flags supported + * + * \return \herr_t + * + * \details Queries a virtual file driver (VFD) for feature flags. Takes a + * VFD hid_t so it can be used before the file is opened. For example, + * this could be used to check if a VFD supports SWMR. + * + * \note The flags obtained here are just those of the base driver and + * do not take any configuration options (e.g., set via a fapl + * call) into consideration. + * + * \since 1.10.2 + */ H5_DLL herr_t H5FDdriver_query(hid_t driver_id, unsigned long *flags /*out*/); #ifdef __cplusplus |