Fix documentation for FIELDQTY.
authorTilghman Lesher <tilghman@meg.abyt.es>
Sun, 31 May 2009 17:52:28 +0000 (17:52 +0000)
committerTilghman Lesher <tilghman@meg.abyt.es>
Sun, 31 May 2009 17:52:28 +0000 (17:52 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@198470 65c4cc65-6c06-0410-ace0-fbb531ad65f3

funcs/func_strings.c

index b4f29b1..de711f6 100644 (file)
@@ -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">