diff options
author | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2022-12-14 21:22:37 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-14 21:22:37 (GMT) |
commit | a1c81eda203addced514ef655f7a9079f3f0bb04 (patch) | |
tree | b6566edef4ba8f4c0fb97ad5df700a696c88f5d1 | |
parent | b7511c19d0d68af5ac664f5b972d68683c84d6e2 (diff) | |
download | hdf5-a1c81eda203addced514ef655f7a9079f3f0bb04.zip hdf5-a1c81eda203addced514ef655f7a9079f3f0bb04.tar.gz hdf5-a1c81eda203addced514ef655f7a9079f3f0bb04.tar.bz2 |
added doc. warning for H5Literate_async return value (#2295)
-rw-r--r-- | src/H5Lpublic.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/H5Lpublic.h b/src/H5Lpublic.h index 6f6c638..60e83f2 100644 --- a/src/H5Lpublic.h +++ b/src/H5Lpublic.h @@ -923,6 +923,11 @@ H5_DLL herr_t H5Literate2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t ord /** * -------------------------------------------------------------------------- * \ingroup ASYNC + * + * \warning The returned value of the callback routine op will not be set + * in the return value for H5Literate_async(), so the \p herr_t value + * should not be used for determining the return state of the callback routine. + * * \async_variant_of{H5Literate} */ #ifndef H5_DOXYGEN |