diff options
author | mattjala <124107509+mattjala@users.noreply.github.com> | 2024-01-29 19:33:21 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-29 19:33:21 (GMT) |
commit | 987a734e759c82c65a661ae6090b2252d63a7aec (patch) | |
tree | 552636e40a91aa7b3601a94338fb6bfb8358d5b0 /src/H5Fpublic.h | |
parent | 3d9f8f878995a9acb8cf4aa6067b86494c696ea5 (diff) | |
download | hdf5-987a734e759c82c65a661ae6090b2252d63a7aec.zip hdf5-987a734e759c82c65a661ae6090b2252d63a7aec.tar.gz hdf5-987a734e759c82c65a661ae6090b2252d63a7aec.tar.bz2 |
Document that fileno is the same for all handles (#3965)
* Document that fileno is same for all handles
* Mention filesystem requirement
Diffstat (limited to 'src/H5Fpublic.h')
-rw-r--r-- | src/H5Fpublic.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/H5Fpublic.h b/src/H5Fpublic.h index ec4097c..551a345 100644 --- a/src/H5Fpublic.h +++ b/src/H5Fpublic.h @@ -740,6 +740,13 @@ H5_DLL herr_t H5Fget_intent(hid_t file_id, unsigned *intent); * file identifier \p file_id and the pointer \p fnumber to the file * number. * + * This file number is the same for all open instances of the same + * file, as long as 1. The active VFD implements the file comparison operator, + * and 2. The current filesystem is able to determine if the same file is opened more + * than once. If these conditions are not met, it is the application's + * responsibility to avoid opening multiple handles into the same file, + * which results in undefined behavior. + * * \since 1.12.0 * */ |