Clarify documentation for function PASSTHRU
authorMatthew Jordan <mjordan@digium.com>
Sun, 14 Jul 2013 02:00:02 +0000 (02:00 +0000)
committerMatthew Jordan <mjordan@digium.com>
Sun, 14 Jul 2013 02:00:02 +0000 (02:00 +0000)
commita3592db1fb558763d28878c707a9cbc16b890e21
tree04a4b4c2792d6a4f5c6bcc64b0989f887b484b89
parent70decd0abe9da563bbbfac94a0d488d9e25010ac
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)
........

Merged revisions 394302 from http://svn.asterisk.org/svn/asterisk/branches/1.8
........

Merged revisions 394303 from http://svn.asterisk.org/svn/asterisk/branches/11

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@394304 65c4cc65-6c06-0410-ace0-fbb531ad65f3
funcs/func_strings.c