diff options
| author | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2022-10-25 17:41:38 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-25 17:41:38 (GMT) |
| commit | 7d1997ff7b545eed7077962fc379e6781c2ccc80 (patch) | |
| tree | a5f03e607247584f04814f20a42e2cffa18a4016 /src/H5ESpublic.h | |
| parent | 23e237e728e4961d0cb7cbea10d5f82a9731bf8c (diff) | |
| download | hdf5-7d1997ff7b545eed7077962fc379e6781c2ccc80.zip hdf5-7d1997ff7b545eed7077962fc379e6781c2ccc80.tar.gz hdf5-7d1997ff7b545eed7077962fc379e6781c2ccc80.tar.bz2 | |
Removed the file, func, line args in the _async APIs fpr doxygen (#2179)
* Removed the: file, func, line args in the _async APIs from the doxygen arguments. Documented H5ESclean.
* format fixes
* fixed DOXYGEN_PREDEFINED
* Fixed the #ifdet logic for doxygen, added missing multi-dataset va_args
* format fixes
* Use H5_DOXYGEN instead of H5_DOXYGEN_FORTRAN
* reordered multidataset declarations
* alt. for H5Aclose_async and H5Acreate_async
* made doxgyen API into seperate blocks
* updated codespell
* Committing clang-format changes
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Diffstat (limited to 'src/H5ESpublic.h')
| -rw-r--r-- | src/H5ESpublic.h | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/src/H5ESpublic.h b/src/H5ESpublic.h index 3aeb872..d99554b 100644 --- a/src/H5ESpublic.h +++ b/src/H5ESpublic.h @@ -178,6 +178,23 @@ H5_DLL hid_t H5EScreate(void); * */ H5_DLL herr_t H5ESwait(hid_t es_id, uint64_t timeout, size_t *num_in_progress, hbool_t *err_occurred); + +/** + * \ingroup H5ES + * + * \brief Attempt to cancel operations in an event set + * + * \es_id + * \param[out] count The number of events not canceled + * \param[out] err_occurred Status indicating if error is present in the event set + * \returns \herr_t + * + * \details H5ESget_count() attempts to cancel operations in an event set specified + * by \p es_id. H5ES_NONE is a valid value for \p es_id, but functions as a no-op. + * + * \since 1.13.0 + * + */ H5_DLL herr_t H5EScancel(hid_t es_id, size_t *num_not_canceled, hbool_t *err_occurred); /** |