[asterisk-commits] tilghman: trunk r198470 - /trunk/funcs/func_strings.c

[SVN commits to the Asterisk project]

Author: tilghman
Date: Sun May 31 12:52:28 2009
New Revision: 198470

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=198470
Log:
Fix documentation for FIELDQTY.

Modified:
    trunk/funcs/func_strings.c

Modified: trunk/funcs/func_strings.c
URL: http://svn.asterisk.org/svn-view/asterisk/trunk/funcs/func_strings.c?view=diff&rev=198470&r1=198469&r2=198470
==============================================================================
--- trunk/funcs/func_strings.c (original)
+++ trunk/funcs/func_strings.c Sun May 31 12:52:28 2009
@@ -51,7 +51,12 @@
 			<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">