summaryrefslogtreecommitdiffstats
path: root/src/H5Mpublic.h
diff options
context:
space:
mode:
authormattjala <124107509+mattjala@users.noreply.github.com>2023-05-15 03:09:58 (GMT)
committerGitHub <noreply@github.com>2023-05-15 03:09:58 (GMT)
commit17750ea9c280784c90456ef81c0f13704483a5fa (patch)
tree4922d8edfd80edca7b17749c021a1b2c69adf92a /src/H5Mpublic.h
parent364145f144cb68a5635ad9f7dad0e4210e3d513a (diff)
downloadhdf5-17750ea9c280784c90456ef81c0f13704483a5fa.zip
hdf5-17750ea9c280784c90456ef81c0f13704483a5fa.tar.gz
hdf5-17750ea9c280784c90456ef81c0f13704483a5fa.tar.bz2
Warn about changing collections during iteration (#2950)
Resolves #92
Diffstat (limited to 'src/H5Mpublic.h')
-rw-r--r--src/H5Mpublic.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/H5Mpublic.h b/src/H5Mpublic.h
index af6aa49..48625a5 100644
--- a/src/H5Mpublic.h
+++ b/src/H5Mpublic.h
@@ -542,6 +542,9 @@ H5_DLL herr_t H5Mexists(hid_t map_id, hid_t key_mem_type_id, const void *key, hb
*
* Any further options can be specified through the property list \p dxpl_id.
*
+ * \warning Adding or removing key-value pairs to the map during iteration
+ * will lead to undefined behavior.
+ *
* \since 1.12.0
*
*/
@@ -583,6 +586,9 @@ H5_DLL herr_t H5Miterate(hid_t map_id, hsize_t *idx, hid_t key_mem_type_id, H5M_
*
* Any further options can be specified through the property list \p dxpl_id.
*
+ * \warning Adding or removing key-value pairs to the map during iteration
+ * will lead to undefined behavior.
+ *
* \since 1.12.0
*
*/