summaryrefslogtreecommitdiffstats
path: root/src/H5ESpublic.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/H5ESpublic.h')
-rw-r--r--src/H5ESpublic.h17
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);
/**