summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorJoshua Colp <jcolp@digium.com>2015-07-07 17:38:59 -0500
committerGerrit Code Review <gerrit2@gerrit.digium.api>2015-07-07 17:38:59 -0500
commit7386a761c12fb0dfff42ea910f768aceff22a505 (patch)
treee61bd1f06c2b63b47a8979da73575eaba3c428d3 /include
parent4c9931046830cf43f08b64b64ce4ad943035319b (diff)
parent0422433f4722e6e692b0c84342e048feff344e80 (diff)
Merge "PJSIP XML, XPIDF: Fix buffer size overwrite memory corruption error." into 13
Diffstat (limited to 'include')
-rw-r--r--include/asterisk/res_pjsip_presence_xml.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/include/asterisk/res_pjsip_presence_xml.h b/include/asterisk/res_pjsip_presence_xml.h
index add5f8918..deed0901e 100644
--- a/include/asterisk/res_pjsip_presence_xml.h
+++ b/include/asterisk/res_pjsip_presence_xml.h
@@ -17,14 +17,15 @@
*/
/*!
- * \brief The length of the XML prolog when printing
- * presence or other XML in PJSIP.
+ * \brief Length of the XML prolog when printing presence or other XML in PJSIP.
*
* When calling any variant of pj_xml_print(), the documentation
* claims that it will return -1 if the provided buffer is not
* large enough. However, if the XML prolog is requested to be
- * printed, then the length of the XML prolog is returned upon
- * failure instead of -1.
+ * printed and the buffer is not large enough, then it will
+ * return -1 only if the buffer is not large enough to hold the
+ * XML prolog or return the length of the XML prolog on failure
+ * instead of -1.
*
* This constant is useful to check against when trying to determine
* if printing XML succeeded or failed.