File: Application_Macro.html

package info (click to toggle)
asterisk 1%3A1.8.13.1~dfsg1-3%2Bdeb7u3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 49,336 kB
  • sloc: ansic: 497,975; sh: 11,763; cpp: 5,934; makefile: 3,065; perl: 3,019; yacc: 2,147; xml: 498; sql: 387; tcl: 113; php: 62; python: 42
file content (82 lines) | stat: -rw-r--r-- 4,355 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <title>Asterisk Project : Application_Macro</title>
	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
    </head>

    <body>
	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
		    <tr>
			    <td valign="top" class="pagebody">
				    <div class="pageheader">
					    <span class="pagetitle">
                            Asterisk Project : Application_Macro
                                                    </span>
				    </div>
				    <div class="pagesubheading">
					    This page last changed on Mar 30, 2011 by <font color="#0050B2">wikibot</font>.
				    </div>

				    <h1><a name="Application_Macro-Macro%28%29"></a>Macro()</h1>

<h3><a name="Application_Macro-Synopsis"></a>Synopsis</h3>
<p>Macro Implementation.</p>

<h3><a name="Application_Macro-Description"></a>Description</h3>
<p>Executes a macro using the context macro- <em>name</em>, jumping to the <tt>s</tt> extension of that context and executing each step, then returning when the steps end. </p>

<p>The calling extension, context, and priority are stored in The calling extension, context, and priority are stored in <tt>None</tt> - <tt>MACRO_EXTEN</tt>, The calling extension, context, and priority are stored in <tt>None</tt> - <tt>MACRO_CONTEXT</tt> and The calling extension, context, and priority are stored in <tt>None</tt> - <tt>MACRO_PRIORITY</tt> respectively. Arguments become The calling extension, context, and priority are stored in <tt>None</tt> - <tt>ARG1</tt>, The calling extension, context, and priority are stored in <tt>None</tt> - <tt>ARG2</tt>, etc in the macro context. </p>

<p>If you Goto out of the Macro context, the Macro will terminate and control will be returned at the location of the Goto. </p>

<p>If If <tt>None</tt> - <tt>MACRO_OFFSET</tt> is set at termination, Macro will attempt to continue at priority MACRO_OFFSET + N + 1 if such a step exists, and N + 1 otherwise. </p>

<p>Because of the way Macro is implemented (it executes the priorities contained within it via sub-engine), and a fixed per-thread memory stack allowance, macros are limited to 7 levels of nesting (macro calling macro calling macro, etc.); It may be possible that stack-intensive applications in deeply nested macros could cause asterisk to crash earlier than this limit. It is advised that if you need to deeply nest macro calls, that you use the Gosub application (now allows arguments like a Macro) with explict Return() calls instead. </p>

<p>Use of the application <tt>WaitExten</tt> within a macro will not function as expected. Please use the <tt>Read</tt> application in order to read DTMF from a channel currently executing a macro.</p>

<h3><a name="Application_Macro-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>Macro(name[,arg1[,arg2[,...]]])</pre>
</div></div>

<h5><a name="Application_Macro-Arguments"></a>Arguments</h5>

<ul>
	<li><tt>name</tt> - The name of the macro</li>
	<li><tt>args</tt>
	<ul>
		<li><tt>arg1</tt></li>
		<li><tt>arg2</tt></li>
	</ul>
	</li>
</ul>



<h3><a name="Application_Macro-SeeAlso"></a>See Also</h3>

<p><a href="Application_MacroExit.html" title="Application_MacroExit">Application&#95;MacroExit</a><br/>
<a href="Application_Goto.html" title="Application_Goto">Application&#95;Goto</a><br/>
<a href="Application_Gosub.html" title="Application_Gosub">Application&#95;Gosub</a></p>


<h3><a name="Application_Macro-ImportVersion"></a>Import Version</h3>
<p>This documentation was imported from Asterisk version SVN-branch-1.8-r311874.</p>

				    
                    			    </td>
		    </tr>
	    </table>
	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
			<tr>
				<td height="12" background="https://wiki.asterisk.org/wiki/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
			</tr>
		    <tr>
			    <td align="center"><font color="grey">Document generated by Confluence on Oct 04, 2011 12:42</font></td>
		    </tr>
	    </table>
    </body>
</html>