philipp/hdf5
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Subfiling VFD - add note to H5Pget_fapl_subfiling documentation

Browse Source 
Adds note about how H5Pget_fapl_subfiling only returns the original
settings on a FAPL and those settings could have been modified by the
Subfiling VFD's environment variables
This commit is contained in:
Jordan Henderson
2022-09-26 12:58:20 -05:00
parent 5fafabd2ad
commit 202784b370
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/H5FDsubfiling/H5FDsubfiling.h
View File

@@ -359,6 +359,16 @@ H5_DLL herr_t H5Pset_fapl_subfiling(hid_t fapl_id, const H5FD_subfiling_config_t
* the default values and then calling H5Pset_fapl_subfiling() with the configured
* H5FD_subfiling_config_t structure.
*
* \note H5Pget_fapl_subfiling() returns the #H5FD_SUBFILING driver properties as they
* were initially set for the File Access Property List using H5Pset_fapl_subfiling().
* Alternatively, the driver properties can be modified at runtime according to values
* set for the #H5FD_SUBFILING_STRIPE_SIZE, #H5FD_SUBFILING_IOC_PER_NODE and
* #H5FD_SUBFILING_IOC_SELECTION_CRITERIA environment variables. However, driver
* properties set through environment variables will not be reflected in what is
* returned by H5Pget_fapl_subfiling(), so an application may need to check those
* environment variables to get accurate values for the #H5FD_SUBFILING driver
* properties.
*
* \since 1.13.2
*
*/