asternet/docs/html/M_AsterNET_FastAGI_AGIScript_GetChannelStatus.htm
richard ralston 25e34f0b25 Adding documentation
Source Tree was giving trouble so commiting through Github app
2016-10-28 09:07:55 +02:00

7 lines
16 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>AGIScript.GetChannelStatus Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="GetChannelStatus method" /><meta name="System.Keywords" content="AGIScript.GetChannelStatus method" /><meta name="Microsoft.Help.F1" content="AsterNET.FastAGI.AGIScript.GetChannelStatus" /><meta name="Microsoft.Help.Id" content="M:AsterNET.FastAGI.AGIScript.GetChannelStatus" /><meta name="Description" content="Returns the status of the channel. Return values: 0 Channel is down and available1 Channel is down, but reserved2 Channel is off hook3 Digits (or equivalent) have been dialed4 Line is ringing5 Remote end is ringing6 Line is up7 Line is busy" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.FastAGI" /><meta name="file" content="M_AsterNET_FastAGI_AGIScript_GetChannelStatus" /><meta name="guid" content="M_AsterNET_FastAGI_AGIScript_GetChannelStatus" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">AsterNet Class Library (Sandcastle documentation)<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="79b6241e-05a3-441c-b6a1-51f2b5b7f265.htm" title="AsterNet Class Library (Sandcastle documentation)" tocid="roottoc">AsterNet Class Library (Sandcastle documentation)</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="N_AsterNET_FastAGI.htm" title="AsterNET.FastAGI" tocid="N_AsterNET_FastAGI">AsterNET.FastAGI</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_AGIScript.htm" title="AGIScript Class" tocid="T_AsterNET_FastAGI_AGIScript">AGIScript Class</a></div><div class="toclevel1" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Methods_T_AsterNET_FastAGI_AGIScript.htm" title="AGIScript Methods" tocid="Methods_T_AsterNET_FastAGI_AGIScript">AGIScript Methods</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_Answer.htm" title="Answer Method " tocid="M_AsterNET_FastAGI_AGIScript_Answer">Answer Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_ControlStreamFile.htm" title="ControlStreamFile Method " tocid="Overload_AsterNET_FastAGI_AGIScript_ControlStreamFile">ControlStreamFile Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_DatabaseDel.htm" title="DatabaseDel Method " tocid="M_AsterNET_FastAGI_AGIScript_DatabaseDel">DatabaseDel Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_DatabaseDelTree.htm" title="DatabaseDelTree Method " tocid="Overload_AsterNET_FastAGI_AGIScript_DatabaseDelTree">DatabaseDelTree Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_DatabaseGet.htm" title="DatabaseGet Method " tocid="M_AsterNET_FastAGI_AGIScript_DatabaseGet">DatabaseGet Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_DatabasePut.htm" title="DatabasePut Method " tocid="M_AsterNET_FastAGI_AGIScript_DatabasePut">DatabasePut Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_Exec.htm" title="Exec Method " tocid="Overload_AsterNET_FastAGI_AGIScript_Exec">Exec Method </a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_GetChannelStatus.htm" title="GetChannelStatus Method " tocid="M_AsterNET_FastAGI_AGIScript_GetChannelStatus">GetChannelStatus Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_GetData.htm" title="GetData Method " tocid="Overload_AsterNET_FastAGI_AGIScript_GetData">GetData Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_GetFullVariable.htm" title="GetFullVariable Method " tocid="Overload_AsterNET_FastAGI_AGIScript_GetFullVariable">GetFullVariable Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_GetOption.htm" title="GetOption Method " tocid="Overload_AsterNET_FastAGI_AGIScript_GetOption">GetOption Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_GetVariable.htm" title="GetVariable Method " tocid="M_AsterNET_FastAGI_AGIScript_GetVariable">GetVariable Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_Hangup.htm" title="Hangup Method " tocid="M_AsterNET_FastAGI_AGIScript_Hangup">Hangup Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_PlayMusicOnHold.htm" title="PlayMusicOnHold Method " tocid="Overload_AsterNET_FastAGI_AGIScript_PlayMusicOnHold">PlayMusicOnHold Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_RecordFile.htm" title="RecordFile Method " tocid="Overload_AsterNET_FastAGI_AGIScript_RecordFile">RecordFile Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayAlpha.htm" title="SayAlpha Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayAlpha">SayAlpha Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayDateTime.htm" title="SayDateTime Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayDateTime">SayDateTime Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayDigits.htm" title="SayDigits Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayDigits">SayDigits Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayNumber.htm" title="SayNumber Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayNumber">SayNumber Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayPhonetic.htm" title="SayPhonetic Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayPhonetic">SayPhonetic Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayTime.htm" title="SayTime Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayTime">SayTime Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_Service.htm" title="Service Method " tocid="M_AsterNET_FastAGI_AGIScript_Service">Service Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_SetAutoHangup.htm" title="SetAutoHangup Method " tocid="M_AsterNET_FastAGI_AGIScript_SetAutoHangup">SetAutoHangup Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_SetCallerId.htm" title="SetCallerId Method " tocid="M_AsterNET_FastAGI_AGIScript_SetCallerId">SetCallerId Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_SetContext.htm" title="SetContext Method " tocid="M_AsterNET_FastAGI_AGIScript_SetContext">SetContext Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_SetExtension.htm" title="SetExtension Method " tocid="M_AsterNET_FastAGI_AGIScript_SetExtension">SetExtension Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SetPriority.htm" title="SetPriority Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SetPriority">SetPriority Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_SetVariable.htm" title="SetVariable Method " tocid="M_AsterNET_FastAGI_AGIScript_SetVariable">SetVariable Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_StopMusicOnHold.htm" title="StopMusicOnHold Method " tocid="M_AsterNET_FastAGI_AGIScript_StopMusicOnHold">StopMusicOnHold Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_StreamFile.htm" title="StreamFile Method " tocid="Overload_AsterNET_FastAGI_AGIScript_StreamFile">StreamFile Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_Verbose.htm" title="Verbose Method " tocid="M_AsterNET_FastAGI_AGIScript_Verbose">Verbose Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_WaitForDigit.htm" title="WaitForDigit Method " tocid="M_AsterNET_FastAGI_AGIScript_WaitForDigit">WaitForDigit Method </a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize"><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize"></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="logoColumn"><img src="../icons/Help.png" /></td><td class="titleColumn">AGIScript<span id="LST36DE6A10_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36DE6A10_0?cpp=::|nu=.");</script>GetChannelStatus Method </td></tr></table><span class="introStyle"></span><div class="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><p> </p><strong>Namespace:</strong> <a href="N_AsterNET_FastAGI.htm">AsterNET.FastAGI</a><br /><strong>Assembly:</strong> AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cs','1','4');return false;">C#</a></div><div id="ID0EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','vb','2','4');return false;">VB</a></div><div id="ID0EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cpp','3','4');return false;">C++</a></div><div id="ID0EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID0EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID0EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">protected</span> <span class="identifier">int</span> <span class="identifier">GetChannelStatus</span>()</pre></div><div id="ID0EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Protected</span> <span class="keyword">Function</span> <span class="identifier">GetChannelStatus</span> <span class="keyword">As</span> <span class="identifier">Integer</span></pre></div><div id="ID0EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">protected</span>:
<span class="identifier">int</span> <span class="identifier">GetChannelStatus</span>()</pre></div><div id="ID0EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">member</span> <span class="identifier">GetChannelStatus</span> : <span class="keyword">unit</span> <span class="keyword">-&gt;</span> <span class="identifier">int</span>
</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><h4 class="subHeading">Return Value</h4>Type: <a href="http://msdn2.microsoft.com/en-us/library/td2s409d" target="_blank">Int32</a><br /> the status of the channel.
</div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID2RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="T_AsterNET_FastAGI_AGIScript.htm">AGIScript Class</a></div><div class="seeAlsoStyle"><a href="N_AsterNET_FastAGI.htm">AsterNET.FastAGI Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>