func_cut: Add example to documentation.

This adds an example to the XML documentation clarifying usage
of the CUT function to address a common misusage.

(cherry picked from commit c0b8adfe4d)
This commit is contained in:
phoneben 2023-07-19 01:05:15 +03:00 committed by Asterisk Development Team
parent 4ed17ced6c
commit cbcde0624b
1 changed files with 4 additions and 0 deletions

View File

@ -75,6 +75,10 @@
</syntax>
<description>
<para>Cut out information from a string (<replaceable>varname</replaceable>), based upon a named delimiter.</para>
<example title="The 'varname' parameter can only accept a variable name, not a variable expression">
exten => s,1,Set(foo=${CUT(bar,,2)}); This is correct syntax
exten => s,2,Set(foo=${CUT(${bar},,2)}); This is invalid syntax (unless bar contains the name of another variable)
</example>
</description>
</function>
***/