From: Mark Michelson Date: Tue, 16 Feb 2010 21:16:44 +0000 (+0000) Subject: Merged revisions 246985 via svnmerge from X-Git-Tag: 1.6.0.26-rc1~42 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9bff7ba440777b94278ebfaf004a7352f45d9247;p=thirdparty%2Fasterisk.git Merged revisions 246985 via svnmerge from https://origsvn.digium.com/svn/asterisk/trunk ........ r246985 | mmichelson | 2010-02-16 15:15:38 -0600 (Tue, 16 Feb 2010) | 3 lines Add some clarifying documentation to the ast_str_set and ast_str_append functions. ........ git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.6.0@246986 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- diff --git a/include/asterisk/strings.h b/include/asterisk/strings.h index e145e2b903..71106eabc9 100644 --- a/include/asterisk/strings.h +++ b/include/asterisk/strings.h @@ -327,11 +327,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) * - * \arg 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