kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-12 15:45:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Manager - Improve documentation for manager commands Getvar and Setvar.

Browse Source 
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
........

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

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


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/12@419944 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Rusty Newton
2014-08-04 19:45:33 +00:00
parent fc2d78f4bf
commit 81f88c2010
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
main/manager.c
View File

@@ -280,7 +280,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</managerEvent>
<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'])" />
@@ -288,22 +288,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'])" />
@@ -311,13 +312,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>