<html><head><metahttp-equiv="X-UA-Compatible"content="IE=edge"/><linkrel="shortcut icon"href="../icons/favicon.ico"/><linkrel="stylesheet"type="text/css"href="../styles/branding.css"/><linkrel="stylesheet"type="text/css"href="../styles/branding-en-US.css"/><scripttype="text/javascript"src="../scripts/branding.js"></script><metahttp-equiv="Content-Type"content="text/html; charset=UTF-8"/><title>AGIScript Class</title><metaname="Language"content="en-us"/><metaname="System.Keywords"content="AGIScript class"/><metaname="System.Keywords"content="AsterNET.FastAGI.AGIScript class"/><metaname="System.Keywords"content="AGIScript class, about AGIScript class"/><metaname="Microsoft.Help.F1"content="AsterNET.FastAGI.AGIScript"/><metaname="Microsoft.Help.Id"content="T:AsterNET.FastAGI.AGIScript"/><metaname="Description"content="The BaseAGIScript provides some convinience methods to make it easier to write custom AGIScripts. Just extend it by your own AGIScripts."/><metaname="Microsoft.Help.ContentType"content="Reference"/><metaname="BrandingAware"content="true"/><metaname="container"content="AsterNET.FastAGI"/><metaname="file"content="T_AsterNET_FastAGI_AGIScript"/><metaname="guid"content="T_AsterNET_FastAGI_AGIScript"/><linkrel="stylesheet"type="text/css"href="../styles/branding-Website.css"/><scripttype="text/javascript"src="../scripts/jquery-1.11.0.min.js"></script><scripttype="text/javascript"src="../scripts/branding-Website.js"></script></head><bodyonload="OnLoad('cs')"><inputtype="hidden"id="userDataCache"class="userDataStyle"/><divclass="pageHeader"id="PageHeader">AsterNet Class Library (Sandcastle documentation)<formid="SearchForm"method="get"action="#"onsubmit="javascript:TransferToSearchPage(); return false;"><inputid="SearchTextBox"type="text"maxlength="200"/><buttonid="SearchButton"type="submit"></button></form></div><divclass="pageBody"><divclass="leftNav"id="leftNav"><divid="tocNav"><divclass="toclevel0"data-toclevel="0"><aclass="tocCollapsed"onclick="javascript: Toggle(this);"href="#!"></a><adata-tochassubtree="true"href="79b6241e-05a3-441c-b6a1-51f2b5b7f265.htm"title="AsterNet Class Library (Sandcastle documentation)"tocid="roottoc">AsterNet Class Library (Sandcastle documentation)</a></div><divclass="toclevel0"data-toclevel="0"><aclass="tocCollapsed"onclick="javascript: Toggle(this);"href="#!"></a><adata-tochassubtree="true"href="N_AsterNET_FastAGI.htm"title="AsterNET.FastAGI"tocid="N_AsterNET_FastAGI">AsterNET.FastAGI</a></div><divclass="toclevel1 current"data-toclevel="1"data-childrenloaded="true"><aclass="tocExpanded"onclick="javascript: Toggle(this);"href="#!"></a><adata-tochassubtree="true"href="T_AsterNET_FastAGI_AGIScript.htm"title="AGIScript Class"tocid="T_AsterNET_FastAGI_AGIScript">AGIScript Class</a></div><divclass="toclevel2"data-toclevel="2"><adata-tochassubtree="false"href="M_AsterNET_FastAGI_AGIScript__ctor.htm"title="AGIScript Constructor "tocid="M_AsterNET_FastAGI_AGIScript__ctor">AGIScript Constructor </a></div><divclass="toclevel2"data-toclevel="2"><aclass="tocCollapsed"onclick="javascript: Toggle(this);"href="#!"></a><adata-tochassubtree="true"href="Methods_T_AsterNET_FastAGI_AGIScript.htm"title="AGIScript Methods"tocid="Methods_T_AsterNET_FastAGI_AGIScript">AGIScript Methods</a></div><divclass="toclevel2"data-toclevel="2"><aclass="tocCollapsed"onclick="javascript: Toggle(this);"href="#!"></a><adata-tochassubtree="true"href="Properties_T_AsterNET_FastAGI_AGIScript.htm"title="AGIScript Properties"tocid="Properties_T_AsterNET_FastAGI_AGIScript">AGIScript Properties</a></div></div><divid="tocResizableEW"onmousedown="OnMouseDown(event);"></div><divid="TocResize"class="tocResize"><imgid="ResizeImageIncrease"src="../icons/TocOpen.gif"onclick="OnIncreaseToc()"alt="Click or drag to resize"title="Click or drag to resize"><imgid="ResizeImageReset"src="../icons/TocClose.gif"style="display:none"onclick="OnResetToc()"alt="Click or drag to resize"title="Clic
The BaseAGIScript provides some convinience methods to make it easier to
<spanclass="keyword">type</span><spanclass="identifier">AGIScript</span> = <spanclass="keyword">class</span><spanclass="keyword">end</span></pre></div></div></div><scripttype="text/javascript">AddLanguageTabSet("ID1EDCA");</script></div><p>The <spanclass="selflink">AGIScript</span> type exposes the following members.</p><divclass="collapsibleAreaRegion"><spanclass="collapsibleRegionTitle"onclick="SectionExpandCollapse('ID3RB')"onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)"tabindex="0"><imgid="ID3RBToggle"class="collapseToggle"src="../icons/SectionExpanded.png"/>Constructors</span></div><divid="ID3RBSection"class="collapsibleSection"><tableid="memberList"class="members"><tr><thclass="iconColumn">
</th><th>Name</th><th>Description</th></tr><trdata="protected;declared;notNetfw;"><td><imgsrc="../icons/protmethod.gif"alt="Protected method"title="Protected method"/></td><td><ahref="M_AsterNET_FastAGI_AGIScript__ctor.htm">AGIScript</a></td><td><divclass="summary">Initializes a new instance of the <spanclass="selflink">AGIScript</span> class</div></td></tr></table><ahref="#PageHeader">Top</a></div><divclass="collapsibleAreaRegion"><spanclass="collapsibleRegionTitle"onclick="SectionExpandCollapse('ID4RB')"onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)"tabindex="0"><imgid="ID4RBToggle"class="collapseToggle"src="../icons/SectionExpanded.png"/>Methods</span></div><divid="ID4RBSection"class="collapsibleSection"><tableid="memberList"class="members"><tr><thclass="iconColumn">
Adds or updates an entry in the Asterisk database for a given family, key and value.
</div></td></tr><trdata="public;inherited;notNetfw;"><td><imgsrc="../icons/pubmethod.gif"alt="Public method"title="Public method"/></td><td><ahref="http://msdn2.microsoft.com/en-us/library/bsc2ak47"target="_blank">Equals</a></td><td><divclass="summary">Determines whether the specified <ahref="http://msdn2.microsoft.com/en-us/library/e5kfa45b"target="_blank">Object</a> is equal to the current <ahref="http://msdn2.microsoft.com/en-us/library/e5kfa45b"target="_blank">Object</a>.</div> (Inherited from <ahref="http://msdn2.microsoft.com/en-us/library/e5kfa45b"target="_blank">Object</a>.)</td></tr><trdata="protected;declared;notNetfw;"><td><imgsrc="../icons/protmethod.gif"alt="Protected method"title="Protected method"/></td><td><ahref="M_AsterNET_FastAGI_AGIScript_Exec.htm">Exec(String)</a></td><td><divclass="summary">
</div></td></tr><trdata="protected;inherited;notNetfw;"><td><imgsrc="../icons/protmethod.gif"alt="Protected method"title="Protected method"/></td><td><ahref="http://msdn2.microsoft.com/en-us/library/4k87zsw7"target="_blank">Finalize</a></td><td><divclass="summary">Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.</div> (Inherited from <ahref="http://msdn2.microsoft.com/en-us/library/e5kfa45b"target="_blank">Object</a>.)</td></tr><trdata="protected;declared;notNetfw;"><td><imgsrc="../icons/protmethod.gif"alt="Protected method"title="Protected method"/></td><td><ahref="M_AsterNET_FastAGI_AGIScript_GetChannelStatus.htm">GetChannelStatus</a></td><td><divclass="summary">
Returns the status of the channel.<br/>
Return values:
<ul><li>0 Channel is down and available</li><li>1 Channel is down, but reserved</li><li>2 Channel is off hook</li><li>3 Digits (or equivalent) have been dialed</li><li>4 Line is ringing</li><li>5 Remote end is ringing</li><li>6 Line is up</li><li>7 Line is busy</li></ul></div></td></tr><trdata="protected;declared;notNetfw;"><td><imgsrc="../icons/protmethod.gif"alt="Protected method"title="Protected method"/></td><td><ahref="M_AsterNET_FastAGI_AGIScript_GetData.htm">GetData(String)</a></td><td><divclass="summary">
Returns the value of the given channel variable.<br/>
Available since Asterisk 1.2.
</div></td></tr><trdata="public;inherited;notNetfw;"><td><imgsrc="../icons/pubmethod.gif"alt="Public method"title="Public method"/></td><td><ahref="http://msdn2.microsoft.com/en-us/library/zdee4b3y"target="_blank">GetHashCode</a></td><td><divclass="summary">Serves as a hash function for a particular type. </div> (Inherited from <ahref="http://msdn2.microsoft.com/en-us/library/e5kfa45b"target="_blank">Object</a>.)</td></tr><trdata="protected;declared;notNetfw;"><td><imgsrc="../icons/protmethod.gif"alt="Protected method"title="Protected method"/></td><td><ahref="M_AsterNET_FastAGI_AGIScript_GetOption.htm">GetOption(String, String)</a></td><td><divclass="summary">
Plays the given file, and waits for the user to press one of the given
digits. If none of the esacpe digits is pressed while streaming the file
it waits for the default timeout of 5 seconds still waiting for the user
Plays the given file, and waits for the user to press one of the given
digits. If none of the esacpe digits is pressed while streaming the file
it waits for the specified timeout still waiting for the user to press a
digit.
</div></td></tr><trdata="public;inherited;notNetfw;"><td><imgsrc="../icons/pubmethod.gif"alt="Public method"title="Public method"/></td><td><ahref="http://msdn2.microsoft.com/en-us/library/dfwy45w9"target="_blank">GetType</a></td><td><divclass="summary">Gets the <ahref="http://msdn2.microsoft.com/en-us/library/42892f65"target="_blank">Type</a> of the current instance.</div> (Inherited from <ahref="http://msdn2.microsoft.com/en-us/library/e5kfa45b"target="_blank">Object</a>.)</td></tr><trdata="protected;declared;notNetfw;"><td><imgsrc="../icons/protmethod.gif"alt="Protected method"title="Protected method"/></td><td><ahref="M_AsterNET_FastAGI_AGIScript_GetVariable.htm">GetVariable</a></td><td><divclass="summary">
</div></td></tr><trdata="protected;inherited;notNetfw;"><td><imgsrc="../icons/protmethod.gif"alt="Protected method"title="Protected method"/></td><td><ahref="http://msdn2.microsoft.com/en-us/library/57ctke0a"target="_blank">MemberwiseClone</a></td><td><divclass="summary">Creates a shallow copy of the current <ahref="http://msdn2.microsoft.com/en-us/library/e5kfa45b"target="_blank">Object</a>.</div> (Inherited from <ahref="http://msdn2.microsoft.com/en-us/library/e5kfa45b"target="_blank">Object</a>.)</td></tr><trdata="protected;declared;notNetfw;"><td><imgsrc="../icons/protmethod.gif"alt="Protected method"title="Protected method"/></td><td><ahref="M_AsterNET_FastAGI_AGIScript_PlayMusicOnHold.htm">PlayMusicOnHold<spanid="LST69BA2BA1_2"></span><scripttype="text/javascript">AddLanguageSpecificTextSet("LST69BA2BA1_2?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a></td><td><divclass="summary">
Plays music on hold from the default music on hold class.
Plays the given file and allows the user to escape by pressing one of the given digit.
</div></td></tr><trdata="public;inherited;notNetfw;"><td><imgsrc="../icons/pubmethod.gif"alt="Public method"title="Public method"/></td><td><ahref="http://msdn2.microsoft.com/en-us/library/7bxwbwt2"target="_blank">ToString</a></td><td><divclass="summary">Returns a string that represents the current object.</div> (Inherited from <ahref="http://msdn2.microsoft.com/en-us/library/e5kfa45b"target="_blank">Object</a>.)</td></tr><trdata="public;declared;notNetfw;"><td><imgsrc="../icons/pubmethod.gif"alt="Public method"title="Public method"/></td><td><ahref="M_AsterNET_FastAGI_AGIScript_Verbose.htm">Verbose</a></td><td><divclass="summary">
Sends a message to the Asterisk console via the verbose message system.