aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--funcs/func_strings.c7
1 files changed, 6 insertions, 1 deletions
diff --git a/funcs/func_strings.c b/funcs/func_strings.c
index cb8a98bea..e84629c38 100644
--- a/funcs/func_strings.c
+++ b/funcs/func_strings.c
@@ -51,7 +51,12 @@ AST_THREADSTORAGE(result_buf);
<parameter name="delim" required="true" />
</syntax>
<description>
- <para>Example: ${FIELDQTY(ex-amp-le,-)} returns 3</para>
+ <para>The delimiter may be specified as a special or extended ASCII character, by encoding it. The characters
+ <literal>\n</literal>, <literal>\r</literal>, and <literal>\t</literal> are all recognized as the newline,
+ carriage return, and tab characters, respectively. Also, octal and hexadecimal specifications are recognized
+ by the patterns <literal>\0nnn</literal> and <literal>\xHH</literal>, respectively. For example, if you wanted
+ to encode a comma as the delimiter, you could use either <literal>\054</literal> or <literal>\x2C</literal>.</para>
+ <para>Example: If ${example} contains <literal>ex-amp-le</literal>, then ${FIELDQTY(example,-)} returns 3.</para>
</description>
</function>
<function name="LISTFILTER" language="en_US">