ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-23 01:25:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add docs template

Browse Source
This commit is contained in:
Karl Burtram
2016-12-15 17:06:28 -08:00
parent b9f1c2b60e 2346ffff38
commit edb3c4aa1f
275 changed files with 10751 additions and 19075 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
docs/_site/api/Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.html
View File

@@ -10,43 +10,45 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class QueueItem
">
<meta name="generator" content="docfx 1.0.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/style.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<!--
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-63735192-1', 'auto');
ga('send', 'pageview');
</script>
-->
</head> <body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<nav class="navbar navbar-inverse">
<div class="container">
<a href="../"><img height="50px" src="../images/sqlserver.png" style="float:right;"></a>
<div class="navbar-header ">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../"><span class="dotnet">SQL Tools Service</span></a>
</div>
<div id="navbar" class="collapse navbar-collapse">
</div><!--/.nav-collapse -->
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
@@ -68,7 +70,8 @@
<div class="col-md-10">
<article class="content wrap" id="_content">
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="pull-right mobile-hide"><span class="fa fa-github"></span>Improve this Doc</a>
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/QueueItem.cs/#L14" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem">Class QueueItem
</h1>
<div class="markdown level0 summary"><p>Class that stores the state of a binding queue request item</p>
@@ -79,30 +82,6 @@
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">QueueItem</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.LanguageServices</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_syntax">Syntax</h5>
@@ -118,7 +97,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/QueueItem.cs/#L19">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.#ctor">QueueItem()</h4>
<div class="markdown level1 summary"><p>QueueItem constructor</p>
</div>
@@ -136,7 +114,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/QueueItem.cs/#L52">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_BindingTimeout_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.BindingTimeout*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_BindingTimeout" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.BindingTimeout">BindingTimeout</h4>
<div class="markdown level1 summary"><p>Gets or sets the binding operation timeout in milliseconds</p>
</div>
@@ -145,7 +122,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int ? BindingTimeout { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -167,7 +144,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/QueueItem.cs/#L32">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_BindOperation_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.BindOperation*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_BindOperation" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.BindOperation">BindOperation</h4>
<div class="markdown level1 summary"><p>Gets or sets the bind operation callback method</p>
</div>
@@ -176,7 +152,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Func&lt;IBindingContext, CancellationToken, object&gt; BindOperation { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -198,7 +174,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/QueueItem.cs/#L42">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_ItemProcessed_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.ItemProcessed*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_ItemProcessed" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.ItemProcessed">ItemProcessed</h4>
<div class="markdown level1 summary"><p>Gets or sets an event to signal when this queue item has been processed</p>
</div>
@@ -207,7 +182,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual ManualResetEvent ItemProcessed { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -229,7 +204,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/QueueItem.cs/#L27">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_Key_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.Key*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_Key" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.Key">Key</h4>
<div class="markdown level1 summary"><p>Gets or sets the queue item key</p>
</div>
@@ -238,7 +212,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Key { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -260,7 +234,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/QueueItem.cs/#L47">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_Result_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.Result*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_Result" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.Result">Result</h4>
<div class="markdown level1 summary"><p>Gets or sets the result of the queued task</p>
</div>
@@ -269,7 +242,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object Result { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -291,7 +264,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/QueueItem.cs/#L37">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_TimeoutOperation_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.TimeoutOperation*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_TimeoutOperation" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.TimeoutOperation">TimeoutOperation</h4>
<div class="markdown level1 summary"><p>Gets or sets the timeout operation to call if the bind operation doesn&#39;t finish within timeout period</p>
</div>
@@ -300,7 +272,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Func&lt;IBindingContext, object&gt; TimeoutOperation { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -322,7 +294,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/QueueItem.cs/#L57">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_WaitForLockTimeout_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.WaitForLockTimeout*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_WaitForLockTimeout" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.WaitForLockTimeout">WaitForLockTimeout</h4>
<div class="markdown level1 summary"><p>Gets or sets the timeout for how long to wait for the binding lock</p>
</div>
@@ -331,7 +302,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int ? WaitForLockTimeout { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -355,7 +326,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/QueueItem.cs/#L62">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_GetResultAsT_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.GetResultAsT*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_QueueItem_GetResultAsT__1" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.GetResultAsT``1">GetResultAsT&lt;T&gt;()</h4>
<div class="markdown level1 summary"><p>Converts the result of the execution to type T</p>
</div>
@@ -379,21 +349,6 @@
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
@@ -418,16 +373,9 @@
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2016 Microsoft<br>Generated by <strong>DocFX</strong></span>
<div class="inner-footer">
<p>© Microsoft &nbsp;//&nbsp; Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
</div>
</div>
</footer>
</div>