mirror of
https://github.com/asterisk/asterisk.git
synced 2025-11-09 11:28:25 +00:00
Clarify documentation for function PASSTHRU
It is not apparent to the average user that the PASSTHRU function should not
be passed as ${PASSTHRU(string)} but just as PASSTHRU(string) to functions
which take a variable name and not its contents.
This patch clarifies the behavior in the documentation and provides an example.
(closes issue ASTERISK-21717)
Reported by: Richard Miller
patches:
func_strings.diff uploaded by Richard Miller (license 5685)
git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.8@394302 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
@@ -147,6 +147,10 @@ AST_THREADSTORAGE(tmp_buf);
|
|||||||
<para>Literally returns the given <replaceable>string</replaceable>. The intent is to permit
|
<para>Literally returns the given <replaceable>string</replaceable>. The intent is to permit
|
||||||
other dialplan functions which take a variable name as an argument to be able to take a literal
|
other dialplan functions which take a variable name as an argument to be able to take a literal
|
||||||
string, instead.</para>
|
string, instead.</para>
|
||||||
|
<note><para>The functions which take a variable name need to be passed var and not
|
||||||
|
${var}. Similarly, use PASSTHRU() and not ${PASSTHRU()}.</para></note>
|
||||||
|
<para>Example: ${CHANNEL} contains SIP/321-1</para>
|
||||||
|
<para> ${CUT(PASSTHRU(${CUT(CHANNEL,-,1)}),/,2)}) will return 321</para>
|
||||||
</description>
|
</description>
|
||||||
</function>
|
</function>
|
||||||
<function name="REGEX" language="en_US">
|
<function name="REGEX" language="en_US">
|
||||||
|
|||||||
Reference in New Issue
Block a user