41 lines
19 KiB
HTML
41 lines
19 KiB
HTML
<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>SetVarAction Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="SetVarAction class" /><meta name="System.Keywords" content="AsterNET.Manager.Action.SetVarAction class" /><meta name="System.Keywords" content="SetVarAction class, about SetVarAction class" /><meta name="Microsoft.Help.F1" content="AsterNET.Manager.Action.SetVarAction" /><meta name="Microsoft.Help.Id" content="T:AsterNET.Manager.Action.SetVarAction" /><meta name="Description" content="The SetVar action sets the value of a channel variable for a given channel." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.Manager.Action" /><meta name="file" content="T_AsterNET_Manager_Action_SetVarAction" /><meta name="guid" content="T_AsterNET_Manager_Action_SetVarAction" /><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_Manager_Action.htm" title="AsterNET.Manager.Action" tocid="N_AsterNET_Manager_Action">AsterNET.Manager.Action</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Action_SetVarAction.htm" title="SetVarAction Class" tocid="T_AsterNET_Manager_Action_SetVarAction">SetVarAction Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_Manager_Action_SetVarAction__ctor.htm" title="SetVarAction Constructor " tocid="Overload_AsterNET_Manager_Action_SetVarAction__ctor">SetVarAction Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Fields_T_AsterNET_Manager_Action_SetVarAction.htm" title="SetVarAction Fields" tocid="Fields_T_AsterNET_Manager_Action_SetVarAction">SetVarAction Fields</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="Methods_T_AsterNET_Manager_Action_SetVarAction.htm" title="SetVarAction Methods" tocid="Methods_T_AsterNET_Manager_Action_SetVarAction">SetVarAction Methods</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Properties_T_AsterNET_Manager_Action_SetVarAction.htm" title="SetVarAction Properties" tocid="Properties_T_AsterNET_Manager_Action_SetVarAction">SetVarAction Properties</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">SetVarAction Class</td></tr></table><span class="introStyle"></span><div class="summary">
|
||
The SetVar action sets the value of a channel variable for a given channel.
|
||
</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Inheritance Hierarchy</span></div><div id="ID0RBSection" class="collapsibleSection"><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LSTC48677F3_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC48677F3_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br /> <a href="T_AsterNET_Manager_Action_ManagerAction.htm">AsterNET.Manager.Action<span id="LSTC48677F3_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC48677F3_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ManagerAction</a><br /> <span class="selflink">AsterNET.Manager.Action<span id="LSTC48677F3_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC48677F3_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>SetVarAction</span><br /></div><p> </p><strong>Namespace:</strong> <a href="N_AsterNET_Manager_Action.htm">AsterNET.Manager.Action</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('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cs','1','4');return false;">C#</a></div><div id="ID1EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','vb','2','4');return false;">VB</a></div><div id="ID1EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cpp','3','4');return false;">C++</a></div><div id="ID1EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID1EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID1EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">SetVarAction</span> : <span class="identifier">ManagerAction</span></pre></div><div id="ID1EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">SetVarAction</span>
|
||
<span class="keyword">Inherits</span> <span class="identifier">ManagerAction</span></pre></div><div id="ID1EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">SetVarAction</span> : <span class="keyword">public</span> <span class="identifier">ManagerAction</span></pre></div><div id="ID1EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">SetVarAction</span> =
|
||
<span class="keyword">class</span>
|
||
<span class="keyword">inherit</span> <span class="identifier">ManagerAction</span>
|
||
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EDCA");</script></div><p>The <span class="selflink">SetVarAction</span> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Constructors</span></div><div id="ID3RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_SetVarAction__ctor.htm">SetVarAction<span id="LSTC48677F3_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC48677F3_3?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a></td><td><div class="summary">
|
||
Creates a new empty SetVarAction.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_SetVarAction__ctor_1.htm">SetVarAction(String, String)</a></td><td><div class="summary">
|
||
Creates a new SetVarAction that sets the given global variable to a new value.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_SetVarAction__ctor_2.htm">SetVarAction(String, String, String)</a></td><td><div class="summary">
|
||
Creates a new SetVarAction that sets the given channel variable of the
|
||
given channel to a new value.
|
||
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID4RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td><div class="summary">Determines whether the specified <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is equal to the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td><div class="summary">Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td><div class="summary">Serves as a hash function for a particular type. </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td><div class="summary">Gets the <a href="http://msdn2.microsoft.com/en-us/library/42892f65" target="_blank">Type</a> of the current instance.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td><div class="summary">Creates a shallow copy of the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_ManagerAction_ToString.htm">ToString</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Fields</span></div><div id="ID5RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_AsterNET_Manager_Action_SetVarAction_channel.htm">channel</a></td><td><div class="summary"> The channel on which to set the variable.</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_AsterNET_Manager_Action_SetVarAction_varName.htm">varName</a></td><td><div class="summary"> The name of the variable to set.</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_AsterNET_Manager_Action_SetVarAction_varValue.htm">varValue</a></td><td><div class="summary"> The value to store.</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Properties</span></div><div id="ID6RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_SetVarAction_Action.htm">Action</a></td><td><div class="summary">
|
||
Get the name of this action, i.e. "SetVar".
|
||
</div> (Overrides <a href="P_AsterNET_Manager_Action_ManagerAction_Action.htm">ManagerAction<span id="LSTC48677F3_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC48677F3_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Action</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_ManagerAction_ActionId.htm">ActionId</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_SetVarAction_Channel.htm">Channel</a></td><td><div class="summary">
|
||
Get/Set the name of the channel.
|
||
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_ManagerAction_ProxyKey.htm">ProxyKey</a></td><td><div class="summary">
|
||
You can use this as a simple authentication mechanism.<br />
|
||
Rather than have to login with a username & password,
|
||
you can specify a <b>ProxyKey</b> that must be passed from
|
||
a client before requests are processed.<br />
|
||
This is helpful in situations where you would like to authenticate and
|
||
execute an action in a single step.
|
||
</div> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_ManagerAction_Server.htm">Server</a></td><td><div class="summary">
|
||
Specify a server to which to send your commands (x.x.x.x or hostname).<br />
|
||
This should match the server name specified in your config file's "host" entry.
|
||
If you do not specify a server, the proxy will pick the first one it finds -- fine in single-server configurations.
|
||
</div> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_SetVarAction_Value.htm">Value</a></td><td><div class="summary">
|
||
Get/Set the value to store.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_SetVarAction_Variable.htm">Variable</a></td><td><div class="summary">
|
||
Get/Set the name of the variable to set.
|
||
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID7RB')" onkeypress="SectionExpandCollapse_CheckKey('ID7RB', event)" tabindex="0"><img id="ID7RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID7RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="N_AsterNET_Manager_Action.htm">AsterNET.Manager.Action Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html> |