Manager - Improve documentation for manager commands Getvar and Setvar.

The documentation for these commands did not make it clear that they could
accept expressions and functions. Modified to make this clear, but tried
not to be overly explicit.

ASTERISK-21178 #close
Reported by: Rusty Newton
Tested by: Rusty Newton

Review: https://reviewboard.asterisk.org/r/3854


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.8@419942 65c4cc65-6c06-0410-ace0-fbb531ad65f3
changes/76/76/1
Rusty Newton 12 years ago
parent dae78b0892
commit e3ad222bb0

@ -204,7 +204,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</manager>
<manager name="Setvar" language="en_US">
<synopsis>
Set a channel variable.
Sets a channel variable or function value.
</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
@ -212,22 +212,23 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Channel to set variable for.</para>
</parameter>
<parameter name="Variable" required="true">
<para>Variable name.</para>
<para>Variable name, function or expression.</para>
</parameter>
<parameter name="Value" required="true">
<para>Variable value.</para>
<para>Variable or function value.</para>
</parameter>
</syntax>
<description>
<para>Set a global or local channel variable.</para>
<para>This command can be used to set the value of channel variables or dialplan
functions.</para>
<note>
<para>If a channel name is not provided then the variable is global.</para>
<para>If a channel name is not provided then the variable is considered global.</para>
</note>
</description>
</manager>
<manager name="Getvar" language="en_US">
<synopsis>
Gets a channel variable.
Gets a channel variable or function value.
</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
@ -235,13 +236,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Channel to read variable from.</para>
</parameter>
<parameter name="Variable" required="true">
<para>Variable name.</para>
<para>Variable name, function or expression.</para>
</parameter>
</syntax>
<description>
<para>Get the value of a global or local channel variable.</para>
<para>Get the value of a channel variable or function return.</para>
<note>
<para>If a channel name is not provided then the variable is global.</para>
<para>If a channel name is not provided then the variable is considered global.</para>
</note>
</description>
</manager>

Loading…
Cancel
Save