diff options
| author | mmichelson <mmichelson@f38db490-d61c-443f-a65b-d21fe96a405b> | 2010-02-16 21:16:44 +0000 |
|---|---|---|
| committer | mmichelson <mmichelson@f38db490-d61c-443f-a65b-d21fe96a405b> | 2010-02-16 21:16:44 +0000 |
| commit | 76c3b063398bebcb47a2b6c197f2a68ed18022e3 (patch) | |
| tree | 4885e7292efd2e340b97f248f7474b15f5ae8658 | |
| parent | 819f1629fa7f29978d3e7001568539a7c0c7dc2c (diff) | |
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.0@246986 f38db490-d61c-443f-a65b-d21fe96a405b
| -rw-r--r-- | include/asterisk/strings.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/include/asterisk/strings.h b/include/asterisk/strings.h index e145e2b90..71106eabc 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 |