kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-29 18:19:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some clarifying documentation to the ast_str_set and ast_str_append functions.

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@246985 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Mark Michelson
2010-02-16 21:15:38 +00:00
parent 0f9e5ab557
commit 164549691e
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
include/asterisk/strings.h
View File

@@ -342,11 +342,16 @@ int ast_get_timeval(const char *src, struct timeval *tv, struct timeval _default
* 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