From 807b2c7085a4118aaffb1149ca4e37a2a07ca2b8 Mon Sep 17 00:00:00 2001 From: mmichelson Date: Tue, 16 Feb 2010 21:17:24 +0000 Subject: 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: http://svn.digium.com/svn/asterisk/branches/1.6.2@246989 f38db490-d61c-443f-a65b-d21fe96a405b --- include/asterisk/strings.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'include') diff --git a/include/asterisk/strings.h b/include/asterisk/strings.h index 43ba361f4..97e1af517 100644 --- a/include/asterisk/strings.h +++ b/include/asterisk/strings.h @@ -337,11 +337,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 -- cgit v1.2.3