aboutsummaryrefslogtreecommitdiffstats
path: root/epan/wmem
diff options
context:
space:
mode:
authorEvan Huus <eapache@gmail.com>2016-05-23 22:12:19 -0400
committerDario Lombardo <lomato@gmail.com>2016-05-24 07:18:03 +0000
commit3ace225e0dc350de43988b9aa2b164d7c87c7602 (patch)
treed7d8841870aa6135a8ce6aaeba79ff82d0adf79b /epan/wmem
parent6d9022d19f92ae0250300746c52a7f47478c93bb (diff)
Document wmem null guarantee
Change-Id: Ibbbda815b144441f7db2d1920e1551c45e997370 Reviewed-on: https://code.wireshark.org/review/15549 Reviewed-by: Michael Mann <mmann78@netscape.net> Reviewed-by: Dario Lombardo <lomato@gmail.com>
Diffstat (limited to 'epan/wmem')
-rw-r--r--epan/wmem/wmem_core.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/epan/wmem/wmem_core.h b/epan/wmem/wmem_core.h
index df263d2516..fc04524de8 100644
--- a/epan/wmem/wmem_core.h
+++ b/epan/wmem/wmem_core.h
@@ -40,6 +40,10 @@ extern "C" {
* many other functions are available (see the "Modules" list at the top of
* the generated doxygen HTML).
*
+ * Any wmem functions which allocate memory are guaranteed to either succeed or
+ * abort the program. However, they *can* still legally return NULL when the
+ * amount of requested memory is zero.
+ *
* @{
*/