summaryrefslogtreecommitdiffstats
path: root/src/H5Gpublic.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/H5Gpublic.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/H5Gpublic.h')
-rw-r--r--src/H5Gpublic.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/H5Gpublic.h b/src/H5Gpublic.h
index 2609fb0..28cfcc4 100644
--- a/src/H5Gpublic.h
+++ b/src/H5Gpublic.h
@@ -1002,7 +1002,10 @@ H5_DLL int H5Gget_comment(hid_t loc_id, const char *name, size_t bufsize, char *
* examine the members of \c subgroup_a. When recursive iteration is
* required, the application must handle the recursion, explicitly
* calling H5Giterate() on discovered subgroups.
-
+ *
+ * \warning Adding or removing members to the group during iteration
+ * will lead to undefined behavior.
+ *
* \version 1.8.0 Function deprecated in this release.
*
*/