[asterisk-commits] mmichelson: trunk r246985 - /trunk/include/asterisk/strings.h

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Tue Feb 16 15:15:38 2010
New Revision: 246985

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=246985
Log:
Add some clarifying documentation to the ast_str_set and ast_str_append functions.


Modified:
    trunk/include/asterisk/strings.h

Modified: trunk/include/asterisk/strings.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/strings.h?view=diff&rev=246985&r1=246984&r2=246985
==============================================================================
--- trunk/include/asterisk/strings.h (original)
+++ trunk/include/asterisk/strings.h Tue Feb 16 15:15:38 2010
@@ -342,11 +342,16 @@
  *	ast_str_set_va(&buf, max_len, ap)
  *	ast_str_append_va(&buf, max_len, ap)
  *
- * \param max_len The maximum allowed length, reallocating if needed.
+ * \param max_len The maximum allowed capacity of the ast_str. Note that
+ *  if the value of max_len is less than the current capacity of the
+ *  ast_str (as returned by ast_str_size), then the parameter is effectively
+ *  ignored.
  * 	0 means unlimited, -1 means "at most the available space"
  *
  * \return All the functions return <0 in case of error, or the
- *	length of the string added to the buffer otherwise.
+ *	length of the string added to the buffer otherwise. Note that
+ *	in most cases where an error is returned, characters ARE written
+ *	to the ast_str.
  */
 
 /*! \brief The descriptor of a dynamic string