2016-10-03 09:15:07 +00:00
< 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 > GetVarAction Class< / title > < meta name = "Language" content = "en-us" / > < meta name = "System.Keywords" content = "GetVarAction class" / > < meta name = "System.Keywords" content = "AsterNET.Manager.Action.GetVarAction class" / > < meta name = "System.Keywords" content = "GetVarAction class, about GetVarAction class" / > < meta name = "Microsoft.Help.F1" content = "AsterNET.Manager.Action.GetVarAction" / > < meta name = "Microsoft.Help.Id" content = "T:AsterNET.Manager.Action.GetVarAction" / > < meta name = "Description" content = "The GetVarAction queries for a channel variable." / > < 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_GetVarAction" / > < meta name = "guid" content = "T_AsterNET_Manager_Action_GetVarAction" / > < 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_GetVarAction.htm" title = "GetVarAction Class" tocid = "T_AsterNET_Manager_Action_GetVarAction" > GetVarAction 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_GetVarAction__ctor.htm" title = "GetVarAction Constructor " tocid = "Overload_AsterNET_Manager_Action_GetVarAction__ctor" > GetVarAction Constructor < / a > < / div > < div class = "toclevel2" data-toclevel = "2" > < a data-tochassubtree = "false" href = "Methods_T_AsterNET_Manager_Action_GetVarAction.htm" title = "GetVarAction Methods" tocid = "Methods_T_AsterNET_Manager_Action_GetVarAction" > GetVarAction 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_GetVarAction.htm" title = "GetVarAction Properties" tocid = "Properties_T_AsterNET_Manager_Action_GetVarAction" > GetVarAction 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 = "Resi
The GetVarAction queries for a channel variable.
< / 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 = "LST3E4C477_0" > < / span > < script type = "text/javascript" > AddLanguageSpecificTextSet ( "LST3E4C477_0?cs=.|vb=.|cpp=::|nu=.|fs=." ) ; < / script > Object< / a > < br / > < a href = "T_AsterNET_Manager_Action_ManagerAction.htm" > AsterNET.Manager.Action< span id = "LST3E4C477_1" > < / span > < script type = "text/javascript" > AddLanguageSpecificTextSet ( "LST3E4C477_1?cs=.|vb=.|cpp=::|nu=.|fs=." ) ; < / script > ManagerAction< / a > < br / > < span class = "selflink" > AsterNET.Manager.Action< span id = "LST3E4C477_2" > < / span > < script type = "text/javascript" > AddLanguageSpecificTextSet ( "LST3E4C477_2?cs=.|vb=.|cpp=::|nu=.|fs=." ) ; < / script > GetVarAction< / span > < br / > < / div > < p > < / p > < strong > Namespace:< / strong > < a href = "N_AsterNET_Manager_Action.htm" > AsterNET.Manager.Action< / a > < br / > < strong > Assembly:< / strong > < 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" > GetVarAction< / 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" > GetVarAction< / 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" > GetVarAction< / 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" > GetVarAction< / 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" > GetVarAction< / 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_GetVarAction__ctor.htm" > GetVarAction< span id = "LST3E4C477_3" > < / span > < script type = "text/javascript" > AddLanguageSpecificTextSet ( "LST3E4C477_3?cs=()|vb=|cpp=()|nu=()|fs=()" ) ; < / script > < / a > < / td > < td > < div class = "summary" >
Creates a new empty GetVarAction.
< / 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_GetVarAction__ctor_1.htm" > GetVarAction(String)< / a > < / td > < td > < div class = "summary" >
Creates a new GetVarAction that queries for the given global variable.
< / 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_GetVarAction__ctor_2.htm" > GetVarAction(String, String)< / a > < / td > < td > < div class = "summary" >
Creates a new GetVarAction that queries for the given local channel variable.
< / 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" / > Properties< / 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/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Action_GetVarAction_Action.htm" > Action< / a > < / td > < td > < div class = "summary" >
Get the name of this action, i.e. "GetVar".
< / div > (Overrides < a href = "P_AsterNET_Manager_Action_ManagerAction_Action.htm" > ManagerAction< span id = "LST3E4C477_4" > < / span > < script type = "text/javascript" > AddLanguageSpecificTextSet ( "LST3E4C477_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_GetVarAction_Channel.htm" > Channel< / a > < / td > < td > < div class = "summary" >
Get/Set the name of the channel, if you query for a local channel variable.
Leave empty to query for a global variable.
2016-10-28 07:07:55 +00:00
< / 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" >
2016-10-03 09:15:07 +00:00
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_GetVarAction_Variable.htm" > Variable< / a > < / td > < td > < div class = "summary" >
Get/Set the name of the variable to query.
< / div > < / td > < / tr > < / table > < a href = "#PageHeader" > Top< / a > < / div > < div class = "collapsibleAreaRegion" id = "seeAlsoSection" > < span class = "collapsibleRegionTitle" onclick = "SectionExpandCollapse('ID6RB')" onkeypress = "SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex = "0" > < img id = "ID6RBToggle" class = "collapseToggle" src = "../icons/SectionExpanded.png" / > See Also< / span > < / div > < div id = "ID6RBSection" 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 >
