mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-27 17:24:26 -05:00
Remove API docs
This commit is contained in:
Karl Burtram
@@ -1 +0,0 @@
|
||||
|
||||
@@ -1,381 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionInfo
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionInfo
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_ConnectionInfo.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo%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/Connection/ConnectionInfo.cs/#L15" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo">Class ConnectionInfo
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Information pertaining to a unique connection instance.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionInfo</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectionInfo</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo__ctor_Microsoft_SqlTools_ServiceLayer_Connection_ISqlConnectionFactory_System_String_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.%23ctor(Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory%2CSystem.String%2CMicrosoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionInfo.cs/#L20">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo__ctor_Microsoft_SqlTools_ServiceLayer_Connection_ISqlConnectionFactory_System_String_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.#ctor(Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory,System.String,Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails)">ConnectionInfo(ISqlConnectionFactory, String, ConnectionDetails)</h4>
|
||||
<div class="markdown level1 summary"><p>Constructor</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConnectionInfo(ISqlConnectionFactory factory, string ownerUri, ConnectionDetails details)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory.html">ISqlConnectionFactory</a></td>
|
||||
<td><em>factory</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>ownerUri</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.html">ConnectionDetails</a></td>
|
||||
<td><em>details</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_ConnectionDetails.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.ConnectionDetails%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionInfo.cs/#L47">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_ConnectionDetails" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.ConnectionDetails">ConnectionDetails</h4>
|
||||
<div class="markdown level1 summary"><p>Properties used for creating/opening the SQL connection.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConnectionDetails ConnectionDetails { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.html">ConnectionDetails</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_ConnectionId.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.ConnectionId%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionInfo.cs/#L32">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_ConnectionId" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.ConnectionId">ConnectionId</h4>
|
||||
<div class="markdown level1 summary"><p>Unique Id, helpful to identify a connection info object</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Guid ConnectionId { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Guid</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_Factory.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.Factory%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionInfo.cs/#L42">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_Factory" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.Factory">Factory</h4>
|
||||
<div class="markdown level1 summary"><p>Factory used for creating the SQL connection associated with the connection info.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ISqlConnectionFactory Factory { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory.html">ISqlConnectionFactory</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_IntellisenseMetrics.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.IntellisenseMetrics%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionInfo.cs/#L57">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_IntellisenseMetrics" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.IntellisenseMetrics">IntellisenseMetrics</h4>
|
||||
<div class="markdown level1 summary"><p>Intellisense Metrics</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public InteractionMetrics<double> IntellisenseMetrics { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.InteractionMetrics-1.html">InteractionMetrics</a><<span class="xref">System.Double</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_IsAzure.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.IsAzure%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionInfo.cs/#L62">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_IsAzure" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.IsAzure">IsAzure</h4>
|
||||
<div class="markdown level1 summary"><p>Returns true is the db connection is to a SQL db</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsAzure { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_OwnerUri.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.OwnerUri%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionInfo.cs/#L37">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_OwnerUri" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.OwnerUri">OwnerUri</h4>
|
||||
<div class="markdown level1 summary"><p>URI identifying the owner/user of the connection. Could be a file, service, resource, etc.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string OwnerUri { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_SqlConnection.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.SqlConnection%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionInfo.cs/#L52">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_SqlConnection" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.SqlConnection">SqlConnection</h4>
|
||||
<div class="markdown level1 summary"><p>The connection to the SQL database that commands will be run against.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DbConnection SqlConnection { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Data.Common.DbConnection</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionInfo.cs/#L15" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,120 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Delegate ConnectionService.OnConnectionHandler
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Delegate ConnectionService.OnConnectionHandler
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_ConnectionService_OnConnectionHandler.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnConnectionHandler%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/Connection/ConnectionService.cs/#L92" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_OnConnectionHandler" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnConnectionHandler">Delegate ConnectionService.OnConnectionHandler
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Callback for onconnection handler</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_OnConnectionHandler_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public delegate Task OnConnectionHandler(ConnectionInfo info);</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_OnConnectionHandler.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnConnectionHandler%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L92" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,119 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Delegate ConnectionService.OnDisconnectHandler
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Delegate ConnectionService.OnDisconnectHandler
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_ConnectionService_OnDisconnectHandler.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnDisconnectHandler%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/Connection/ConnectionService.cs/#L97" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_OnDisconnectHandler" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnDisconnectHandler">Delegate ConnectionService.OnDisconnectHandler
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_OnDisconnectHandler_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public delegate Task OnDisconnectHandler(ConnectionSummary summary, string ownerUri);</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_OnDisconnectHandler.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnDisconnectHandler%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L97" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,923 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionService
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionService
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_ConnectionService.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService%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/Connection/ConnectionService.cs/#L28" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService">Class ConnectionService
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Main class for the Connection Management services</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionService</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectionService</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService__ctor.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.%23ctor%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L84">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.#ctor">ConnectionService()</h4>
|
||||
<div class="markdown level1 summary"><p>Default constructor should be private since it's a singleton class, but we need a constructor
|
||||
for use in unit test mocking.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConnectionService()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService__ctor_Microsoft_SqlTools_ServiceLayer_Connection_ISqlConnectionFactory_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.%23ctor(Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L128">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService__ctor_Microsoft_SqlTools_ServiceLayer_Connection_ISqlConnectionFactory_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.#ctor(Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory)">ConnectionService(ISqlConnectionFactory)</h4>
|
||||
<div class="markdown level1 summary"><p>Test constructor that injects dependency interfaces</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConnectionService(ISqlConnectionFactory testFactory)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory.html">ISqlConnectionFactory</a></td>
|
||||
<td><em>testFactory</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_ConnectionFactory.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.ConnectionFactory%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L112">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_ConnectionFactory" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.ConnectionFactory">ConnectionFactory</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the SQL connection factory instance</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ISqlConnectionFactory ConnectionFactory { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory.html">ISqlConnectionFactory</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_Instance.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.Instance%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L39">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_Instance" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.Instance">Instance</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the singleton service instance</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static ConnectionService Instance { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.html">ConnectionService</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_BuildConnectionString_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.BuildConnectionString(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L605">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_BuildConnectionString_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.BuildConnectionString(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails)">BuildConnectionString(ConnectionDetails)</h4>
|
||||
<div class="markdown level1 summary"><p>Build a connection string from a connection details instance</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string BuildConnectionString(ConnectionDetails connectionDetails)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.html">ConnectionDetails</a></td>
|
||||
<td><em>connectionDetails</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_CancelConnect_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectParams_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.CancelConnect(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L309">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_CancelConnect_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectParams_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.CancelConnect(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams)">CancelConnect(CancelConnectParams)</h4>
|
||||
<div class="markdown level1 summary"><p>Cancel a connection that is in the process of opening.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool CancelConnect(CancelConnectParams cancelParams)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams.html">CancelConnectParams</a></td>
|
||||
<td><em>cancelParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_ChangeConnectionDatabaseContext_System_String_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.ChangeConnectionDatabaseContext(System.String%2CSystem.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L737">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_ChangeConnectionDatabaseContext_System_String_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.ChangeConnectionDatabaseContext(System.String,System.String)">ChangeConnectionDatabaseContext(String, String)</h4>
|
||||
<div class="markdown level1 summary"><p>Change the database context of a connection.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void ChangeConnectionDatabaseContext(string ownerUri, string newDatabaseName)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>ownerUri</em></td>
|
||||
<td><p>URI of the owner of the connection</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>newDatabaseName</em></td>
|
||||
<td><p>Name of the database to change the connection to</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_Connect_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.Connect(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L143">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_Connect_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.Connect(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams)">Connect(ConnectParams)</h4>
|
||||
<div class="markdown level1 summary"><p>Open a connection with the specified connection details</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task<ConnectionCompleteParams> Connect(ConnectParams connectionParams)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams.html">ConnectParams</a></td>
|
||||
<td><em>connectionParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.html">ConnectionCompleteParams</a>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_Disconnect_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectParams_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.Disconnect(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L340">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_Disconnect_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectParams_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.Disconnect(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams)">Disconnect(DisconnectParams)</h4>
|
||||
<div class="markdown level1 summary"><p>Close a connection with the specified connection details.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Disconnect(DisconnectParams disconnectParams)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams.html">DisconnectParams</a></td>
|
||||
<td><em>disconnectParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleCancelConnectRequest_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_System_Boolean__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleCancelConnectRequest(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BSystem.Boolean%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L535">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleCancelConnectRequest_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_System_Boolean__" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleCancelConnectRequest(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{System.Boolean})">HandleCancelConnectRequest(CancelConnectParams, RequestContext<Boolean>)</h4>
|
||||
<div class="markdown level1 summary"><p>Handle cancel connect requests</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected Task HandleCancelConnectRequest(CancelConnectParams cancelParams, RequestContext<bool> requestContext)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams.html">CancelConnectParams</a></td>
|
||||
<td><em>cancelParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<span class="xref">System.Boolean</span>></td>
|
||||
<td><em>requestContext</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleConnectRequest_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_System_Boolean__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleConnectRequest(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BSystem.Boolean%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L493">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleConnectRequest_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_System_Boolean__" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleConnectRequest(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{System.Boolean})">HandleConnectRequest(ConnectParams, RequestContext<Boolean>)</h4>
|
||||
<div class="markdown level1 summary"><p>Handle new connection requests</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected Task HandleConnectRequest(ConnectParams connectParams, RequestContext<bool> requestContext)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams.html">ConnectParams</a></td>
|
||||
<td><em>connectParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<span class="xref">System.Boolean</span>></td>
|
||||
<td><em>requestContext</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleDidChangeConfigurationNotification_Microsoft_SqlTools_ServiceLayer_SqlContext_SqlToolsSettings_Microsoft_SqlTools_ServiceLayer_SqlContext_SqlToolsSettings_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleDidChangeConfigurationNotification(Microsoft.SqlTools.ServiceLayer.SqlContext.SqlToolsSettings%2CMicrosoft.SqlTools.ServiceLayer.SqlContext.SqlToolsSettings%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L593">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleDidChangeConfigurationNotification_Microsoft_SqlTools_ServiceLayer_SqlContext_SqlToolsSettings_Microsoft_SqlTools_ServiceLayer_SqlContext_SqlToolsSettings_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleDidChangeConfigurationNotification(Microsoft.SqlTools.ServiceLayer.SqlContext.SqlToolsSettings,Microsoft.SqlTools.ServiceLayer.SqlContext.SqlToolsSettings,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext)">HandleDidChangeConfigurationNotification(SqlToolsSettings, SqlToolsSettings, EventContext)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task HandleDidChangeConfigurationNotification(SqlToolsSettings newSettings, SqlToolsSettings oldSettings, EventContext eventContext)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.SqlContext.SqlToolsSettings.html">SqlToolsSettings</a></td>
|
||||
<td><em>newSettings</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.SqlContext.SqlToolsSettings.html">SqlToolsSettings</a></td>
|
||||
<td><em>oldSettings</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a></td>
|
||||
<td><em>eventContext</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleDisconnectRequest_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_System_Boolean__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleDisconnectRequest(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BSystem.Boolean%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L555">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleDisconnectRequest_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_System_Boolean__" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleDisconnectRequest(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{System.Boolean})">HandleDisconnectRequest(DisconnectParams, RequestContext<Boolean>)</h4>
|
||||
<div class="markdown level1 summary"><p>Handle disconnect requests</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected Task HandleDisconnectRequest(DisconnectParams disconnectParams, RequestContext<bool> requestContext)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams.html">DisconnectParams</a></td>
|
||||
<td><em>disconnectParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<span class="xref">System.Boolean</span>></td>
|
||||
<td><em>requestContext</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleListDatabasesRequest_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesResponse__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleListDatabasesRequest(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BMicrosoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesResponse%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L576">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleListDatabasesRequest_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesResponse__" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleListDatabasesRequest(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesResponse})">HandleListDatabasesRequest(ListDatabasesParams, RequestContext<ListDatabasesResponse>)</h4>
|
||||
<div class="markdown level1 summary"><p>Handle requests to list databases on the current server</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected Task HandleListDatabasesRequest(ListDatabasesParams listDatabasesParams, RequestContext<ListDatabasesResponse> requestContext)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams.html">ListDatabasesParams</a></td>
|
||||
<td><em>listDatabasesParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesResponse.html">ListDatabasesResponse</a>></td>
|
||||
<td><em>requestContext</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_InitializeService_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.InitializeService(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L456">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_InitializeService_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.InitializeService(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint)">InitializeService(IProtocolEndpoint)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void InitializeService(IProtocolEndpoint serviceHost)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.html">IProtocolEndpoint</a></td>
|
||||
<td><em>serviceHost</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_ListDatabases_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesParams_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.ListDatabases(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L404">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_ListDatabases_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesParams_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.ListDatabases(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams)">ListDatabases(ListDatabasesParams)</h4>
|
||||
<div class="markdown level1 summary"><p>List all databases on the server specified</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ListDatabasesResponse ListDatabases(ListDatabasesParams listDatabasesParams)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams.html">ListDatabasesParams</a></td>
|
||||
<td><em>listDatabasesParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesResponse.html">ListDatabasesResponse</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_RegisterOnConnectionTask_Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_OnConnectionHandler_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.RegisterOnConnectionTask(Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnConnectionHandler)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L474">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_RegisterOnConnectionTask_Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_OnConnectionHandler_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.RegisterOnConnectionTask(Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnConnectionHandler)">RegisterOnConnectionTask(ConnectionService.OnConnectionHandler)</h4>
|
||||
<div class="markdown level1 summary"><p>Add a new method to be called when the onconnection request is submitted </p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void RegisterOnConnectionTask(ConnectionService.OnConnectionHandler activity)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnConnectionHandler.html">ConnectionService.OnConnectionHandler</a></td>
|
||||
<td><em>activity</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_RegisterOnDisconnectTask_Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_OnDisconnectHandler_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.RegisterOnDisconnectTask(Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnDisconnectHandler)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L482">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_RegisterOnDisconnectTask_Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_OnDisconnectHandler_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.RegisterOnDisconnectTask(Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnDisconnectHandler)">RegisterOnDisconnectTask(ConnectionService.OnDisconnectHandler)</h4>
|
||||
<div class="markdown level1 summary"><p>Add a new method to be called when the ondisconnect request is submitted</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void RegisterOnDisconnectTask(ConnectionService.OnDisconnectHandler activity)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnDisconnectHandler.html">ConnectionService.OnDisconnectHandler</a></td>
|
||||
<td><em>activity</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_TryFindConnection_System_String_Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.TryFindConnection(System.String%2CMicrosoft.SqlTools.ServiceLayer.Connection.ConnectionInfo%40)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L134">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_TryFindConnection_System_String_Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo__" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.TryFindConnection(System.String,Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo@)">TryFindConnection(String, out ConnectionInfo)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public virtual bool TryFindConnection(string ownerUri, out ConnectionInfo connectionInfo)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>ownerUri</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.html">ConnectionInfo</a></td>
|
||||
<td><em>connectionInfo</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs/#L28" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,158 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class CancelConnectParams
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class CancelConnectParams
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_CancelConnectParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams%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/Connection/Contracts/CancelConnectParams.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectParams" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams">Class CancelConnectParams
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Parameters for the Cancel Connect Request.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">CancelConnectParams</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectParams_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CancelConnectParams</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectParams_OwnerUri.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams.OwnerUri%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/CancelConnectParams.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectParams_OwnerUri" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams.OwnerUri">OwnerUri</h4>
|
||||
<div class="markdown level1 summary"><p>A URI identifying the owner of the connection. This will most commonly be a file in the workspace
|
||||
or a virtual file representing an object in a database. </p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string OwnerUri { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/CancelConnectParams.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,141 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class CancelConnectRequest
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class CancelConnectRequest
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_CancelConnectRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectRequest%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/Connection/Contracts/CancelConnectRequest.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectRequest" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectRequest">Class CancelConnectRequest
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Cancel connect request mapping entry </p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">CancelConnectRequest</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectRequest_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CancelConnectRequest</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectRequest_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectRequest.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/CancelConnectRequest.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectRequest_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectRequest.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly RequestType<CancelConnectParams, bool> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_CancelConnectRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectRequest%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/CancelConnectRequest.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,191 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectParams
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectParams
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams%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/Connection/Contracts/ConnectParams.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams">Class ConnectParams
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Parameters for the Connect Request.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectParams</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectParams</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_Connection.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams.Connection%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectParams.cs/#L24">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_Connection" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams.Connection">Connection</h4>
|
||||
<div class="markdown level1 summary"><p>Contains the required parameters to initialize a connection to a database.
|
||||
A connection will identified by its server name, database name and user name.
|
||||
This may be changed in the future to support multiple connections with different
|
||||
connection properties to the same database.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConnectionDetails Connection { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.html">ConnectionDetails</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_OwnerUri.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams.OwnerUri%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectParams.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_OwnerUri" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams.OwnerUri">OwnerUri</h4>
|
||||
<div class="markdown level1 summary"><p>A URI identifying the owner of the connection. This will most commonly be a file in the workspace
|
||||
or a virtual file representing an object in a database. </p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string OwnerUri { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectParams.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,179 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectParamsExtensions
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectParamsExtensions
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectParamsExtensions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParamsExtensions%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/Connection/Contracts/ConnectParamsExtensions.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParamsExtensions" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParamsExtensions">Class ConnectParamsExtensions
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Extension methods to ConnectParams</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectParamsExtensions</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParamsExtensions_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class ConnectParamsExtensions</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParamsExtensions_IsValid_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_System_String__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParamsExtensions.IsValid(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams%2CSystem.String%40)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectParamsExtensions.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParamsExtensions_IsValid_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParams_System_String__" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParamsExtensions.IsValid(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams,System.String@)">IsValid(ConnectParams, out String)</h4>
|
||||
<div class="markdown level1 summary"><p>Check that the fields in ConnectParams are all valid</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool IsValid(this ConnectParams parameters, out string errorMessage)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams.html">ConnectParams</a></td>
|
||||
<td><em>parameters</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>errorMessage</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectParamsExtensions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParamsExtensions%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectParamsExtensions.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,141 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionChangedNotification
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionChangedNotification
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectionChangedNotification.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedNotification%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/Connection/Contracts/ConnectionChangedNotification.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedNotification" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedNotification">Class ConnectionChangedNotification
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>ConnectionChanged notification mapping entry </p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionChangedNotification</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedNotification_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectionChangedNotification</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedNotification_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedNotification.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionChangedNotification.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedNotification_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedNotification.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly EventType<ConnectionChangedParams> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedNotification.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedNotification%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionChangedNotification.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,188 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionChangedParams
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionChangedParams
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectionChangedParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedParams%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/Connection/Contracts/ConnectionChangedParams.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedParams" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedParams">Class ConnectionChangedParams
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Parameters for the ConnectionChanged Notification.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionChangedParams</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedParams_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectionChangedParams</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedParams_Connection.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedParams.Connection%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionChangedParams.cs/#L21">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedParams_Connection" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedParams.Connection">Connection</h4>
|
||||
<div class="markdown level1 summary"><p>Contains the high-level properties about the connection, for display to the user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConnectionSummary Connection { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.html">ConnectionSummary</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedParams_OwnerUri.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedParams.OwnerUri%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionChangedParams.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedParams_OwnerUri" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedParams.OwnerUri">OwnerUri</h4>
|
||||
<div class="markdown level1 summary"><p>A URI identifying the owner of the connection. This will most commonly be a file in the workspace
|
||||
or a virtual file representing an object in a database. </p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string OwnerUri { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionChangedParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedParams%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionChangedParams.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,141 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionCompleteNotification
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionCompleteNotification
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectionCompleteNotification.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteNotification%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/Connection/Contracts/ConnectionCompleteNotification.cs/#L55" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteNotification" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteNotification">Class ConnectionCompleteNotification
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>ConnectionComplete notification mapping entry </p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionCompleteNotification</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteNotification_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectionCompleteNotification</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteNotification_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteNotification.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs/#L58">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteNotification_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteNotification.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly EventType<ConnectionCompleteParams> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteNotification.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteNotification%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs/#L55" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,338 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionCompleteParams
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionCompleteParams
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectionCompleteParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams%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/Connection/Contracts/ConnectionCompleteNotification.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams">Class ConnectionCompleteParams
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Parameters to be sent back with a connection complete event</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionCompleteParams</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectionCompleteParams</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_ConnectionId.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.ConnectionId%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs/#L24">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_ConnectionId" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.ConnectionId">ConnectionId</h4>
|
||||
<div class="markdown level1 summary"><p>A GUID representing a unique connection ID</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ConnectionId { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_ConnectionSummary.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.ConnectionSummary%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs/#L49">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_ConnectionSummary" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.ConnectionSummary">ConnectionSummary</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the actual Connection established, including Database Name</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConnectionSummary ConnectionSummary { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.html">ConnectionSummary</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_ErrorMessage.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.ErrorMessage%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs/#L34">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_ErrorMessage" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.ErrorMessage">ErrorMessage</h4>
|
||||
<div class="markdown level1 summary"><p>Error message returned from the engine for a connection failure reason, if any.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ErrorMessage { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_ErrorNumber.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.ErrorNumber%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs/#L39">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_ErrorNumber" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.ErrorNumber">ErrorNumber</h4>
|
||||
<div class="markdown level1 summary"><p>Error number returned from the engine for connection failure reason, if any.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ErrorNumber { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_Messages.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.Messages%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs/#L29">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_Messages" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.Messages">Messages</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets any detailed connection error messages.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Messages { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_OwnerUri.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.OwnerUri%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs/#L19">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_OwnerUri" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.OwnerUri">OwnerUri</h4>
|
||||
<div class="markdown level1 summary"><p>A URI identifying the owner of the connection. This will most commonly be a file in the workspace
|
||||
or a virtual file representing an object in a database. </p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string OwnerUri { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_ServerInfo.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.ServerInfo%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs/#L44">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams_ServerInfo" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.ServerInfo">ServerInfo</h4>
|
||||
<div class="markdown level1 summary"><p>Information about the connected server.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ServerInfo ServerInfo { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.html">ServerInfo</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionCompleteParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,821 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionDetails
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionDetails
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectionDetails.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails%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/Connection/Contracts/ConnectionDetails.cs/#L14" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails">Class ConnectionDetails
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Message format for the initial connection request</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.html">ConnectionSummary</a></div>
|
||||
<div class="level2"><span class="xref">ConnectionDetails</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectionDetails : ConnectionSummary</code></pre>
|
||||
</div>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_remarks"><strong>Remarks</strong></h5>
|
||||
<div class="markdown level0 remarks"><p>If this contract is ever changed, be sure to update ConnectionDetailsExtensions methods.</p>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_ApplicationIntent.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.ApplicationIntent%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L70">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_ApplicationIntent" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.ApplicationIntent">ApplicationIntent</h4>
|
||||
<div class="markdown level1 summary"><p>Declares the application workload type when connecting to a database in an SQL Server Availability Group.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ApplicationIntent { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_ApplicationName.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.ApplicationName%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L60">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_ApplicationName" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.ApplicationName">ApplicationName</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the name of the application associated with the connection string.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ApplicationName { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_AttachDbFilename.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.AttachDbFilename%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L105">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_AttachDbFilename" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.AttachDbFilename">AttachDbFilename</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a string that contains the name of the primary data file. This includes the full path name of an attachable database.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string AttachDbFilename { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_AuthenticationType.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.AuthenticationType%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L25">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_AuthenticationType" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.AuthenticationType">AuthenticationType</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the authentication to use.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string AuthenticationType { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_ConnectRetryCount.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.ConnectRetryCount%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L50">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_ConnectRetryCount" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.ConnectRetryCount">ConnectRetryCount</h4>
|
||||
<div class="markdown level1 summary"><p>The number of reconnections attempted after identifying that there was an idle connection failure.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ? ConnectRetryCount { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_ConnectRetryInterval.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.ConnectRetryInterval%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L55">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_ConnectRetryInterval" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.ConnectRetryInterval">ConnectRetryInterval</h4>
|
||||
<div class="markdown level1 summary"><p>Amount of time (in seconds) between each reconnection attempt after identifying that there was an idle connection failure.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ? ConnectRetryInterval { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_ConnectTimeout.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.ConnectTimeout%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L45">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_ConnectTimeout" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.ConnectTimeout">ConnectTimeout</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ? ConnectTimeout { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_CurrentLanguage.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.CurrentLanguage%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L75">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_CurrentLanguage" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.CurrentLanguage">CurrentLanguage</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the SQL Server Language record name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string CurrentLanguage { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_Encrypt.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.Encrypt%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L30">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_Encrypt" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.Encrypt">Encrypt</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a Boolean value that indicates whether SQL Server uses SSL encryption for all data sent between the client and server if the server has a certificate installed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? Encrypt { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_FailoverPartner.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.FailoverPartner%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L110">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_FailoverPartner" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.FailoverPartner">FailoverPartner</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the name or address of the partner server to connect to if the primary server is down.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string FailoverPartner { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_LoadBalanceTimeout.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.LoadBalanceTimeout%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L95">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_LoadBalanceTimeout" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.LoadBalanceTimeout">LoadBalanceTimeout</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the minimum time, in seconds, for the connection to live in the connection pool before being destroyed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ? LoadBalanceTimeout { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_MaxPoolSize.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.MaxPoolSize%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L85">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_MaxPoolSize" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.MaxPoolSize">MaxPoolSize</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the maximum number of connections allowed in the connection pool for this specific connection string.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ? MaxPoolSize { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_MinPoolSize.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.MinPoolSize%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L90">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_MinPoolSize" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.MinPoolSize">MinPoolSize</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the minimum number of connections allowed in the connection pool for this specific connection string.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ? MinPoolSize { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_MultipleActiveResultSets.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.MultipleActiveResultSets%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L120">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_MultipleActiveResultSets" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.MultipleActiveResultSets">MultipleActiveResultSets</h4>
|
||||
<div class="markdown level1 summary"><p>When true, an application can maintain multiple active result sets (MARS).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? MultipleActiveResultSets { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_MultiSubnetFailover.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.MultiSubnetFailover%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L115">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_MultiSubnetFailover" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.MultiSubnetFailover">MultiSubnetFailover</h4>
|
||||
<div class="markdown level1 summary"><p>If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? MultiSubnetFailover { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_PacketSize.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.PacketSize%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L125">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_PacketSize" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.PacketSize">PacketSize</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the size in bytes of the network packets used to communicate with an instance of SQL Server.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ? PacketSize { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_Password.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.Password%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L20">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_Password" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.Password">Password</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the connection password</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Password { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_PersistSecurityInfo.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.PersistSecurityInfo%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L40">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_PersistSecurityInfo" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.PersistSecurityInfo">PersistSecurityInfo</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a Boolean value that indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? PersistSecurityInfo { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_Pooling.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.Pooling%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L80">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_Pooling" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.Pooling">Pooling</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a Boolean value that indicates whether the connection will be pooled or explicitly opened every time that the connection is requested.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? Pooling { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_Replication.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.Replication%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L100">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_Replication" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.Replication">Replication</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a Boolean value that indicates whether replication is supported using the connection.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? Replication { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_TrustServerCertificate.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.TrustServerCertificate%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L35">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_TrustServerCertificate" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.TrustServerCertificate">TrustServerCertificate</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a value that indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? TrustServerCertificate { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_TypeSystemVersion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.TypeSystemVersion%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L130">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_TypeSystemVersion" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.TypeSystemVersion">TypeSystemVersion</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a string value that indicates the type system the application expects.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string TypeSystemVersion { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_WorkstationId.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.WorkstationId%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L65">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_WorkstationId" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.WorkstationId">WorkstationId</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the name of the workstation connecting to SQL Server.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string WorkstationId { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs/#L14" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,174 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionDetailsExtensions
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionDetailsExtensions
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectionDetailsExtensions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetailsExtensions%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/Connection/Contracts/ConnectionDetailsExtensions.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetailsExtensions" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetailsExtensions">Class ConnectionDetailsExtensions
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Extension methods for the ConnectionDetails contract class</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionDetailsExtensions</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetailsExtensions_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class ConnectionDetailsExtensions</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetailsExtensions_Clone_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetailsExtensions.Clone(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetailsExtensions.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetailsExtensions_Clone_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetails_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetailsExtensions.Clone(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails)">Clone(ConnectionDetails)</h4>
|
||||
<div class="markdown level1 summary"><p>Create a copy of a connection details object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static ConnectionDetails Clone(this ConnectionDetails details)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.html">ConnectionDetails</a></td>
|
||||
<td><em>details</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.html">ConnectionDetails</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionDetailsExtensions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetailsExtensions%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetailsExtensions.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,141 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionRequest
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionRequest
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectionRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionRequest%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/Connection/Contracts/ConnectionRequest.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionRequest" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionRequest">Class ConnectionRequest
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Connect request mapping entry </p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionRequest</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionRequest_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectionRequest</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionRequest_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionRequest.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionRequest.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionRequest_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionRequest.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly RequestType<ConnectParams, bool> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionRequest%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionRequest.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,217 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionSummary
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionSummary
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectionSummary.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary%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/Connection/Contracts/ConnectionSummary.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary">Class ConnectionSummary
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Provides high level information about a connection.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionSummary</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectionSummary</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_DatabaseName.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.DatabaseName%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionSummary.cs/#L21">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_DatabaseName" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.DatabaseName">DatabaseName</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the connection database name</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string DatabaseName { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_ServerName.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.ServerName%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionSummary.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_ServerName" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.ServerName">ServerName</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the connection server name</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ServerName { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_UserName.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.UserName%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionSummary.cs/#L26">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_UserName" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.UserName">UserName</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the connection user name</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string UserName { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionSummary.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,224 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionSummaryComparer
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionSummaryComparer
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectionSummaryComparer.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryComparer%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/Connection/Contracts/ConnectionSummaryComparer.cs/#L15" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryComparer" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryComparer">Class ConnectionSummaryComparer
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Treats connections as the same if their server, db and usernames all match</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionSummaryComparer</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryComparer_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectionSummaryComparer : IEqualityComparer<ConnectionSummary></code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryComparer_Equals_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryComparer.Equals(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary%2CMicrosoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionSummaryComparer.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryComparer_Equals_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryComparer.Equals(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary,Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary)">Equals(ConnectionSummary, ConnectionSummary)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Equals(ConnectionSummary x, ConnectionSummary y)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.html">ConnectionSummary</a></td>
|
||||
<td><em>x</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.html">ConnectionSummary</a></td>
|
||||
<td><em>y</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryComparer_GetHashCode_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryComparer.GetHashCode(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionSummaryComparer.cs/#L32">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryComparer_GetHashCode_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryComparer.GetHashCode(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary)">GetHashCode(ConnectionSummary)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int GetHashCode(ConnectionSummary obj)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.html">ConnectionSummary</a></td>
|
||||
<td><em>obj</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryComparer.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryComparer%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionSummaryComparer.cs/#L15" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,174 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectionSummaryExtensions
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectionSummaryExtensions
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ConnectionSummaryExtensions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryExtensions%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/Connection/Contracts/ConnectionSummaryExtensions.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryExtensions" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryExtensions">Class ConnectionSummaryExtensions
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Extension methods to ConnectionSummary</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectionSummaryExtensions</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryExtensions_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class ConnectionSummaryExtensions</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryExtensions_Clone_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryExtensions.Clone(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionSummaryExtensions.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryExtensions_Clone_Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummary_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryExtensions.Clone(Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary)">Clone(ConnectionSummary)</h4>
|
||||
<div class="markdown level1 summary"><p>Create a copy of a ConnectionSummary object</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static ConnectionSummary Clone(this ConnectionSummary summary)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.html">ConnectionSummary</a></td>
|
||||
<td><em>summary</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.html">ConnectionSummary</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ConnectionSummaryExtensions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryExtensions%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionSummaryExtensions.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,158 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class DisconnectParams
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class DisconnectParams
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_DisconnectParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams%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/Connection/Contracts/DisconnectParams.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectParams" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams">Class DisconnectParams
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Parameters for the Disconnect Request.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">DisconnectParams</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectParams_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class DisconnectParams</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectParams_OwnerUri.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams.OwnerUri%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/DisconnectParams.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectParams_OwnerUri" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams.OwnerUri">OwnerUri</h4>
|
||||
<div class="markdown level1 summary"><p>A URI identifying the owner of the connection. This will most commonly be a file in the workspace
|
||||
or a virtual file representing an object in a database. </p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string OwnerUri { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/DisconnectParams.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,141 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class DisconnectRequest
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class DisconnectRequest
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_DisconnectRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectRequest%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/Connection/Contracts/DisconnectRequest.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectRequest" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectRequest">Class DisconnectRequest
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Disconnect request mapping entry </p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">DisconnectRequest</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectRequest_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class DisconnectRequest</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectRequest_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectRequest.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/DisconnectRequest.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectRequest_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectRequest.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly RequestType<DisconnectParams, bool> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_DisconnectRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectRequest%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/DisconnectRequest.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,157 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ListDatabasesParams
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ListDatabasesParams
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ListDatabasesParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams%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/Connection/Contracts/ListDatabasesParams.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesParams" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams">Class ListDatabasesParams
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Parameters for the List Databases Request.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ListDatabasesParams</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesParams_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ListDatabasesParams</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesParams_OwnerUri.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams.OwnerUri%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ListDatabasesParams.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesParams_OwnerUri" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams.OwnerUri">OwnerUri</h4>
|
||||
<div class="markdown level1 summary"><p>URI of the owner of the connection requesting the list of databases.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string OwnerUri { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ListDatabasesParams.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,141 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ListDatabasesRequest
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ListDatabasesRequest
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ListDatabasesRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesRequest%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/Connection/Contracts/ListDatabasesRequest.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesRequest" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesRequest">Class ListDatabasesRequest
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>List databases request mapping entry </p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ListDatabasesRequest</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesRequest_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ListDatabasesRequest</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesRequest_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesRequest.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ListDatabasesRequest.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesRequest_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesRequest.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly RequestType<ListDatabasesParams, ListDatabasesResponse> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesRequest%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ListDatabasesRequest.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,157 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ListDatabasesResponse
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ListDatabasesResponse
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ListDatabasesResponse.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesResponse%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/Connection/Contracts/ListDatabasesResponse.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesResponse" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesResponse">Class ListDatabasesResponse
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Message format for the list databases response</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ListDatabasesResponse</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesResponse_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ListDatabasesResponse</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesResponse_DatabaseNames.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesResponse.DatabaseNames%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ListDatabasesResponse.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesResponse_DatabaseNames" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesResponse.DatabaseNames">DatabaseNames</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the list of database names.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string[] DatabaseNames { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span>[]</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ListDatabasesResponse.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesResponse%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ListDatabasesResponse.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,427 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ServerInfo
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ServerInfo
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts_ServerInfo.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo%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/Connection/Contracts/ServerInfo.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo">Class ServerInfo
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Contract for information on the connected SQL Server instance.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ServerInfo</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ServerInfo</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_AzureVersion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.AzureVersion%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L56">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_AzureVersion" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.AzureVersion">AzureVersion</h4>
|
||||
<div class="markdown level1 summary"><p>The version of Azure that the SQL Server instance is running on, if applicable.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int AzureVersion { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_EngineEditionId.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.EngineEditionId%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L31">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_EngineEditionId" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.EngineEditionId">EngineEditionId</h4>
|
||||
<div class="markdown level1 summary"><p>The ID of the engine edition of the SQL Server instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int EngineEditionId { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_IsCloud.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.IsCloud%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L51">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_IsCloud" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.IsCloud">IsCloud</h4>
|
||||
<div class="markdown level1 summary"><p>Whether the SQL Server instance is running in the cloud (Azure) or not.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsCloud { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_OsVersion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.OsVersion%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L61">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_OsVersion" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.OsVersion">OsVersion</h4>
|
||||
<div class="markdown level1 summary"><p>The Operating System version string of the machine running the SQL Server instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string OsVersion { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerEdition.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerEdition%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L46">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerEdition" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerEdition">ServerEdition</h4>
|
||||
<div class="markdown level1 summary"><p>The edition of the SQL Server instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ServerEdition { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerLevel.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerLevel%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L41">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerLevel" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerLevel">ServerLevel</h4>
|
||||
<div class="markdown level1 summary"><p>String describing the product level of the server.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ServerLevel { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerMajorVersion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerMajorVersion%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerMajorVersion" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerMajorVersion">ServerMajorVersion</h4>
|
||||
<div class="markdown level1 summary"><p>The major version of the SQL Server instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ServerMajorVersion { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerMinorVersion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerMinorVersion%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L21">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerMinorVersion" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerMinorVersion">ServerMinorVersion</h4>
|
||||
<div class="markdown level1 summary"><p>The minor version of the SQL Server instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ServerMinorVersion { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerReleaseVersion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerReleaseVersion%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L26">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerReleaseVersion" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerReleaseVersion">ServerReleaseVersion</h4>
|
||||
<div class="markdown level1 summary"><p>The build of the SQL Server instance.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ServerReleaseVersion { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerVersion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerVersion%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L36">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo_ServerVersion" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.ServerVersion">ServerVersion</h4>
|
||||
<div class="markdown level1 summary"><p>String containing the full server version text.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string ServerVersion { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts_ServerInfo.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ServerInfo.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,172 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Connection.Contracts
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Connection.Contracts
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_Contracts.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_Contracts" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.Contracts">Namespace Microsoft.SqlTools.ServiceLayer.Connection.Contracts
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectParams.html">CancelConnectParams</a></h4>
|
||||
<section><p>Parameters for the Cancel Connect Request.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.CancelConnectRequest.html">CancelConnectRequest</a></h4>
|
||||
<section><p>Cancel connect request mapping entry </p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedNotification.html">ConnectionChangedNotification</a></h4>
|
||||
<section><p>ConnectionChanged notification mapping entry </p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionChangedParams.html">ConnectionChangedParams</a></h4>
|
||||
<section><p>Parameters for the ConnectionChanged Notification.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteNotification.html">ConnectionCompleteNotification</a></h4>
|
||||
<section><p>ConnectionComplete notification mapping entry </p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionCompleteParams.html">ConnectionCompleteParams</a></h4>
|
||||
<section><p>Parameters to be sent back with a connection complete event</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetails.html">ConnectionDetails</a></h4>
|
||||
<section><p>Message format for the initial connection request</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionDetailsExtensions.html">ConnectionDetailsExtensions</a></h4>
|
||||
<section><p>Extension methods for the ConnectionDetails contract class</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionRequest.html">ConnectionRequest</a></h4>
|
||||
<section><p>Connect request mapping entry </p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummary.html">ConnectionSummary</a></h4>
|
||||
<section><p>Provides high level information about a connection.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryComparer.html">ConnectionSummaryComparer</a></h4>
|
||||
<section><p>Treats connections as the same if their server, db and usernames all match</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectionSummaryExtensions.html">ConnectionSummaryExtensions</a></h4>
|
||||
<section><p>Extension methods to ConnectionSummary</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParams.html">ConnectParams</a></h4>
|
||||
<section><p>Parameters for the Connect Request.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ConnectParamsExtensions.html">ConnectParamsExtensions</a></h4>
|
||||
<section><p>Extension methods to ConnectParams</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectParams.html">DisconnectParams</a></h4>
|
||||
<section><p>Parameters for the Disconnect Request.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.DisconnectRequest.html">DisconnectRequest</a></h4>
|
||||
<section><p>Disconnect request mapping entry </p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesParams.html">ListDatabasesParams</a></h4>
|
||||
<section><p>Parameters for the List Databases Request.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesRequest.html">ListDatabasesRequest</a></h4>
|
||||
<section><p>List databases request mapping entry </p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ListDatabasesResponse.html">ListDatabasesResponse</a></h4>
|
||||
<section><p>Message format for the list databases response</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.Contracts.ServerInfo.html">ServerInfo</a></h4>
|
||||
<section><p>Contract for information on the connected SQL Server instance.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_Contracts.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.Contracts%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,169 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Interface ISqlConnectionFactory
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Interface ISqlConnectionFactory
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_ISqlConnectionFactory.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory%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/Connection/ISqlConnectionFactory.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_ISqlConnectionFactory" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory">Interface ISqlConnectionFactory
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Interface for the SQL Connection factory</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_ISqlConnectionFactory_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface ISqlConnectionFactory</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ISqlConnectionFactory_CreateSqlConnection_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory.CreateSqlConnection(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ISqlConnectionFactory.cs/#L18">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_ISqlConnectionFactory_CreateSqlConnection_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory.CreateSqlConnection(System.String)">CreateSqlConnection(String)</h4>
|
||||
<div class="markdown level1 summary"><p>Create a new SQL Connection object</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">DbConnection CreateSqlConnection(string connectionString)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>connectionString</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Data.Common.DbConnection</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_ISqlConnectionFactory.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/ISqlConnectionFactory.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,176 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class SqlConnectionFactory
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class SqlConnectionFactory
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection_SqlConnectionFactory.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.SqlConnectionFactory%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/Connection/SqlConnectionFactory.cs/#L16" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection_SqlConnectionFactory" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.SqlConnectionFactory">Class SqlConnectionFactory
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Factory class to create SqlClientConnections
|
||||
The purpose of the factory is to make it easier to mock out the database
|
||||
in 'offline' unit test scenarios.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">SqlConnectionFactory</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Connection</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Connection_SqlConnectionFactory_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SqlConnectionFactory : ISqlConnectionFactory</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_SqlConnectionFactory_CreateSqlConnection_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.SqlConnectionFactory.CreateSqlConnection(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/SqlConnectionFactory.cs/#L21">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Connection_SqlConnectionFactory_CreateSqlConnection_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.SqlConnectionFactory.CreateSqlConnection(System.String)">CreateSqlConnection(String)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates a new SqlConnection object</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DbConnection CreateSqlConnection(string connectionString)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>connectionString</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Data.Common.DbConnection</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection_SqlConnectionFactory.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection.SqlConnectionFactory%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Connection/SqlConnectionFactory.cs/#L16" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,135 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Connection
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Connection
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Connection.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Connection" data-uid="Microsoft.SqlTools.ServiceLayer.Connection">Namespace Microsoft.SqlTools.ServiceLayer.Connection
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.html">ConnectionInfo</a></h4>
|
||||
<section><p>Information pertaining to a unique connection instance.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.html">ConnectionService</a></h4>
|
||||
<section><p>Main class for the Connection Management services</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.SqlConnectionFactory.html">SqlConnectionFactory</a></h4>
|
||||
<section><p>Factory class to create SqlClientConnections
|
||||
The purpose of the factory is to make it easier to mock out the database
|
||||
in 'offline' unit test scenarios.</p>
|
||||
</section>
|
||||
<h3 id="interfaces">Interfaces
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ISqlConnectionFactory.html">ISqlConnectionFactory</a></h4>
|
||||
<section><p>Interface for the SQL Connection factory</p>
|
||||
</section>
|
||||
<h3 id="delegates">Delegates
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnConnectionHandler.html">ConnectionService.OnConnectionHandler</a></h4>
|
||||
<section><p>Callback for onconnection handler</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.OnDisconnectHandler.html">ConnectionService.OnDisconnectHandler</a></h4>
|
||||
<section></section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Connection.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Connection%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,341 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class Credential
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class Credential
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Contracts_Credential.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential%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/Credentials/Contracts/Credential.cs/#L16" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential">Class Credential
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>A Credential containing information needed to log into a resource. This is primarily
|
||||
defined as a unique <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId">CredentialId</a> with an associated <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password">Password</a>
|
||||
that's linked to it. </p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">Credential</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Credential</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.%23ctor%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L31">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.#ctor">Credential()</h4>
|
||||
<div class="markdown level1 summary"><p>Default Constructor</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Credential()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.%23ctor(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L39">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.#ctor(System.String)">Credential(String)</h4>
|
||||
<div class="markdown level1 summary"><p>Constructor used when only <span class="paramref">credentialId</span> is known</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Credential(string credentialId)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>credentialId</em></td>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId">CredentialId</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor_System_String_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.%23ctor(System.String%2CSystem.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L50">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor_System_String_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.#ctor(System.String,System.String)">Credential(String, String)</h4>
|
||||
<div class="markdown level1 summary"><p>Constructor</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Credential(string credentialId, string password)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>credentialId</em></td>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId">CredentialId</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>password</em></td>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password">Password</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.CredentialId%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L21">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.CredentialId">CredentialId</h4>
|
||||
<div class="markdown level1 summary"><p>A unique ID to identify the credential being saved. </p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string CredentialId { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.Password%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L26">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.Password">Password</h4>
|
||||
<div class="markdown level1 summary"><p>The Password stored for this credential. </p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Password { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_ValidateForLookup_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.ValidateForLookup(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L68">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_ValidateForLookup_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.ValidateForLookup(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential)">ValidateForLookup(Credential)</h4>
|
||||
<div class="markdown level1 summary"><p>Validates the credential has all the properties needed to look up the password</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ValidateForLookup(Credential credential)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a></td>
|
||||
<td><em>credential</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_ValidateForSave_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.ValidateForSave(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L78">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_ValidateForSave_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.ValidateForSave(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential)">ValidateForSave(Credential)</h4>
|
||||
<div class="markdown level1 summary"><p>Validates the credential has all the properties needed to save a password</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void ValidateForSave(Credential credential)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a></td>
|
||||
<td><em>credential</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L16" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,142 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class DeleteCredentialRequest
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class DeleteCredentialRequest
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Contracts_DeleteCredentialRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.DeleteCredentialRequest%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/Credentials/Contracts/Credential.cs/#L115" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_DeleteCredentialRequest" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.DeleteCredentialRequest">Class DeleteCredentialRequest
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Delete Credential request mapping entry</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">DeleteCredentialRequest</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_DeleteCredentialRequest_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class DeleteCredentialRequest</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_DeleteCredentialRequest_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.DeleteCredentialRequest.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L121">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_DeleteCredentialRequest_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.DeleteCredentialRequest.Type">Type</h4>
|
||||
<div class="markdown level1 summary"><p>Request definition</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly RequestType<Credential, bool> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_DeleteCredentialRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.DeleteCredentialRequest%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L115" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,143 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ReadCredentialRequest
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ReadCredentialRequest
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Contracts_ReadCredentialRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.ReadCredentialRequest%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/Credentials/Contracts/Credential.cs/#L89" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_ReadCredentialRequest" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.ReadCredentialRequest">Class ReadCredentialRequest
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Read Credential request mapping entry. Expects a Credential with CredentialId,
|
||||
and responds with the <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password">Password</a> filled in if found</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ReadCredentialRequest</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_ReadCredentialRequest_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ReadCredentialRequest</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_ReadCredentialRequest_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.ReadCredentialRequest.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L95">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_ReadCredentialRequest_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.ReadCredentialRequest.Type">Type</h4>
|
||||
<div class="markdown level1 summary"><p>Request definition</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly RequestType<Credential, Credential> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_ReadCredentialRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.ReadCredentialRequest%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L89" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,142 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class SaveCredentialRequest
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class SaveCredentialRequest
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Contracts_SaveCredentialRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.SaveCredentialRequest%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/Credentials/Contracts/Credential.cs/#L102" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_SaveCredentialRequest" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.SaveCredentialRequest">Class SaveCredentialRequest
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Save Credential request mapping entry</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">SaveCredentialRequest</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_SaveCredentialRequest_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SaveCredentialRequest</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_SaveCredentialRequest_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.SaveCredentialRequest.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L108">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_SaveCredentialRequest_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.SaveCredentialRequest.Type">Type</h4>
|
||||
<div class="markdown level1 summary"><p>Request definition</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly RequestType<Credential, bool> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_SaveCredentialRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.SaveCredentialRequest%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L102" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,127 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Credentials.Contracts
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Credentials.Contracts
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Contracts.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts">Namespace Microsoft.SqlTools.ServiceLayer.Credentials.Contracts
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a></h4>
|
||||
<section><p>A Credential containing information needed to log into a resource. This is primarily
|
||||
defined as a unique <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId">CredentialId</a> with an associated <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password">Password</a>
|
||||
that's linked to it. </p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.DeleteCredentialRequest.html">DeleteCredentialRequest</a></h4>
|
||||
<section><p>Delete Credential request mapping entry</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.ReadCredentialRequest.html">ReadCredentialRequest</a></h4>
|
||||
<section><p>Read Credential request mapping entry. Expects a Credential with CredentialId,
|
||||
and responds with the <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password">Password</a> filled in if found</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.SaveCredentialRequest.html">SaveCredentialRequest</a></h4>
|
||||
<section><p>Save Credential request mapping entry</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,344 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class CredentialService
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class CredentialService
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_CredentialService.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService%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/Credentials/CredentialService.cs/#L22" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService">Class CredentialService
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Service responsible for securing credentials in a platform-neutral manner. This provides
|
||||
a generic API for read, save and delete credentials</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">CredentialService</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CredentialService</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_Instance.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.Instance%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/CredentialService.cs/#L37">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_Instance" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.Instance">Instance</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the singleton service instance</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static CredentialService Instance { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.html">CredentialService</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_HandleDeleteCredentialRequest_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_System_Boolean__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.HandleDeleteCredentialRequest(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BSystem.Boolean%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/CredentialService.cs/#L127">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_HandleDeleteCredentialRequest_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_System_Boolean__" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.HandleDeleteCredentialRequest(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{System.Boolean})">HandleDeleteCredentialRequest(Credential, RequestContext<Boolean>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task HandleDeleteCredentialRequest(Credential credential, RequestContext<bool> requestContext)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a></td>
|
||||
<td><em>credential</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<span class="xref">System.Boolean</span>></td>
|
||||
<td><em>requestContext</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_HandleReadCredentialRequest_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.HandleReadCredentialRequest(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BMicrosoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/CredentialService.cs/#L94">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_HandleReadCredentialRequest_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.HandleReadCredentialRequest(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential})">HandleReadCredentialRequest(Credential, RequestContext<Credential>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task HandleReadCredentialRequest(Credential credential, RequestContext<Credential> requestContext)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a></td>
|
||||
<td><em>credential</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a>></td>
|
||||
<td><em>requestContext</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_HandleSaveCredentialRequest_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_System_Boolean__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.HandleSaveCredentialRequest(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BSystem.Boolean%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/CredentialService.cs/#L117">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_HandleSaveCredentialRequest_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_System_Boolean__" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.HandleSaveCredentialRequest(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{System.Boolean})">HandleSaveCredentialRequest(Credential, RequestContext<Boolean>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task HandleSaveCredentialRequest(Credential credential, RequestContext<bool> requestContext)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a></td>
|
||||
<td><em>credential</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<span class="xref">System.Boolean</span>></td>
|
||||
<td><em>requestContext</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_InitializeService_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.InitializeService(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/CredentialService.cs/#L86">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService_InitializeService_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.InitializeService(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint)">InitializeService(IProtocolEndpoint)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void InitializeService(IProtocolEndpoint serviceHost)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.html">IProtocolEndpoint</a></td>
|
||||
<td><em>serviceHost</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_CredentialService.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/CredentialService.cs/#L22" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,276 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Interface ICredentialStore
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Interface ICredentialStore
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_ICredentialStore.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore%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/Credentials/ICredentialStore.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_ICredentialStore" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore">Interface ICredentialStore
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>An <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore.html">ICredentialStore</a> support securely saving and retrieving passwords</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_ICredentialStore_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface ICredentialStore</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_ICredentialStore_DeletePassword_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore.DeletePassword(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/ICredentialStore.cs/#L38">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_ICredentialStore_DeletePassword_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore.DeletePassword(System.String)">DeletePassword(String)</h4>
|
||||
<div class="markdown level1 summary"><p>Deletes a password linked to a given credential</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">bool DeletePassword(string credentialId)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>credentialId</em></td>
|
||||
<td><p>The name of the credential to find the password for. This is required</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><p>True if password existed and was deleted, false otherwise</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_ICredentialStore_Save_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore.Save(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/ICredentialStore.cs/#L23">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_ICredentialStore_Save_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore.Save(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential)">Save(Credential)</h4>
|
||||
<div class="markdown level1 summary"><p>Saves a Password linked to a given Credential</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">bool Save(Credential credential)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a></td>
|
||||
<td><em>credential</em></td>
|
||||
<td><p>A <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a> to be saved.
|
||||
<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId">CredentialId</a> and <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password">Password</a> are required</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><p>True if successful, false otherwise</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_ICredentialStore_TryGetPassword_System_String_System_String__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore.TryGetPassword(System.String%2CSystem.String%40)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/ICredentialStore.cs/#L31">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_ICredentialStore_TryGetPassword_System_String_System_String__" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore.TryGetPassword(System.String,System.String@)">TryGetPassword(String, out String)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets a Password and sets it into a <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a> object</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">bool TryGetPassword(string credentialId, out string password)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>credentialId</em></td>
|
||||
<td><p>The name of the credential to find the password for. This is required</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>password</em></td>
|
||||
<td><p>Out value</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><p>true if password was found, false otherwise</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_ICredentialStore.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/ICredentialStore.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,156 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class CredentialsWrapper
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class CredentialsWrapper
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Linux_CredentialsWrapper.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux.CredentialsWrapper%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/Credentials/Linux/CredentialsWrapper.cs/#L14" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux_CredentialsWrapper" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Linux.CredentialsWrapper">Class CredentialsWrapper
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Simplified class to enable writing a set of credentials to/from disk</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">CredentialsWrapper</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Linux</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux_CredentialsWrapper_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CredentialsWrapper</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Linux_CredentialsWrapper_Credentials.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux.CredentialsWrapper.Credentials%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Linux/CredentialsWrapper.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux_CredentialsWrapper_Credentials" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Linux.CredentialsWrapper.Credentials">Credentials</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public List<Credential> Credentials { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.List</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Linux_CredentialsWrapper.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux.CredentialsWrapper%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Linux/CredentialsWrapper.cs/#L14" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,269 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class FileTokenStorage
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class FileTokenStorage
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Linux_FileTokenStorage.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage%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/Credentials/Linux/FileTokenStorage.cs/#L19" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage">Class FileTokenStorage
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">FileTokenStorage</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Linux</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class FileTokenStorage</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage__ctor_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.%23ctor(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Linux/FileTokenStorage.cs/#L27">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage__ctor_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.#ctor(System.String)">FileTokenStorage(String)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public FileTokenStorage(string fileName)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>fileName</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage_AddEntries_System_Collections_Generic_IEnumerable_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__System_Collections_Generic_IEnumerable_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.AddEntries(System.Collections.Generic.IEnumerable%7BMicrosoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential%7D%2CSystem.Collections.Generic.IEnumerable%7BMicrosoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Linux/FileTokenStorage.cs/#L33">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage_AddEntries_System_Collections_Generic_IEnumerable_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__System_Collections_Generic_IEnumerable_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.AddEntries(System.Collections.Generic.IEnumerable{Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential},System.Collections.Generic.IEnumerable{Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential})">AddEntries(IEnumerable<Credential>, IEnumerable<Credential>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void AddEntries(IEnumerable<Credential> newEntries, IEnumerable<Credential> existingEntries)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a>></td>
|
||||
<td><em>newEntries</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a>></td>
|
||||
<td><em>existingEntries</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage_Clear.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.Clear%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Linux/FileTokenStorage.cs/#L39">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage_Clear" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.Clear">Clear()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Clear()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage_LoadEntries.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.LoadEntries%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Linux/FileTokenStorage.cs/#L44">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage_LoadEntries" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.LoadEntries">LoadEntries()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Credential> LoadEntries()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage_SaveEntries_System_Collections_Generic_IEnumerable_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.SaveEntries(System.Collections.Generic.IEnumerable%7BMicrosoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Linux/FileTokenStorage.cs/#L65">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage_SaveEntries_System_Collections_Generic_IEnumerable_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.SaveEntries(System.Collections.Generic.IEnumerable{Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential})">SaveEntries(IEnumerable<Credential>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SaveEntries(IEnumerable<Credential> entries)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a>></td>
|
||||
<td><em>entries</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Linux_FileTokenStorage.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Linux/FileTokenStorage.cs/#L19" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,117 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Credentials.Linux
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Credentials.Linux
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Linux.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Linux" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Linux">Namespace Microsoft.SqlTools.ServiceLayer.Credentials.Linux
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Linux.CredentialsWrapper.html">CredentialsWrapper</a></h4>
|
||||
<section><p>Simplified class to enable writing a set of credentials to/from disk</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Linux.FileTokenStorage.html">FileTokenStorage</a></h4>
|
||||
<section></section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Linux.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Linux%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,262 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class CredentialSet
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class CredentialSet
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Win32_CredentialSet.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet%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/Credentials/Win32/CredentialSet.cs/#L15" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet">Class CredentialSet
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">System.Collections.Generic.List</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.html">Win32Credential</a>></div>
|
||||
<div class="level2"><span class="xref">CredentialSet</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Win32</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CredentialSet : List<Win32Credential>, IList<Win32Credential>, ICollection<Win32Credential>, IReadOnlyList<Win32Credential>, IReadOnlyCollection<Win32Credential>, IEnumerable<Win32Credential>, IList, ICollection, IEnumerable, IDisposable</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet__ctor.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.%23ctor%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/CredentialSet.cs/#L19">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.#ctor">CredentialSet()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CredentialSet()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet__ctor_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.%23ctor(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/CredentialSet.cs/#L23">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet__ctor_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.#ctor(System.String)">CredentialSet(String)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CredentialSet(string target)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>target</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet_Target.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.Target%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/CredentialSet.cs/#L33">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet_Target" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.Target">Target</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Target { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet_Dispose.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.Dispose%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/CredentialSet.cs/#L36">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet_Dispose" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.Dispose">Dispose()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet_Finalize.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.Finalize%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/CredentialSet.cs/#L44">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet_Finalize" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.Finalize">Finalize()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected void Finalize()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet_Load.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.Load%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/CredentialSet.cs/#L64">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet_Load" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.Load">Load()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CredentialSet Load()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.html">CredentialSet</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialSet.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/CredentialSet.cs/#L15" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,150 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Enum CredentialType
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Enum CredentialType
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<div class="col-md-10">
|
||||
<article class="content wrap" id="_content">
|
||||
|
||||
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialType" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialType">Enum CredentialType
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Win32</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialType_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum CredentialType : uint</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialType_DomainCertificate">DomainCertificate</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialType_DomainPassword">DomainPassword</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialType_DomainVisiblePassword">DomainVisiblePassword</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialType_Generic">Generic</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialType_None">None</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</thead></thead></table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialType.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialType%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/CredentialType.cs/#L8" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,142 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Enum PersistanceType
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Enum PersistanceType
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<div class="col-md-10">
|
||||
<article class="content wrap" id="_content">
|
||||
|
||||
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_PersistanceType" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.PersistanceType">Enum PersistanceType
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Win32</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_PersistanceType_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum PersistanceType : uint</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_PersistanceType_Enterprise">Enterprise</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_PersistanceType_LocalComputer">LocalComputer</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_PersistanceType_Session">Session</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</thead></thead></table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_PersistanceType.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.PersistanceType%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/PersistanceType.cs/#L8" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,689 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class Win32Credential
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class Win32Credential
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Win32_Win32Credential.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential%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/Credentials/Win32/Win32Credential.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential">Class Win32Credential
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">Win32Credential</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Win32</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Win32Credential : IDisposable</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential__ctor.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.%23ctor%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L25">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.#ctor">Win32Credential()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Win32Credential()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential__ctor_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.%23ctor(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L30">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential__ctor_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.#ctor(System.String)">Win32Credential(String)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Win32Credential(string username)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>username</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential__ctor_System_String_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.%23ctor(System.String%2CSystem.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L35">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential__ctor_System_String_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.#ctor(System.String,System.String)">Win32Credential(String, String)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Win32Credential(string username, string password)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>username</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>password</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential__ctor_System_String_System_String_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.%23ctor(System.String%2CSystem.String%2CSystem.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L40">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential__ctor_System_String_System_String_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.#ctor(System.String,System.String,System.String)">Win32Credential(String, String, String)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Win32Credential(string username, string password, string target)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>username</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>password</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>target</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential__ctor_System_String_System_String_System_String_Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialType_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.%23ctor(System.String%2CSystem.String%2CSystem.String%2CMicrosoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialType)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L45">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential__ctor_System_String_System_String_System_String_Microsoft_SqlTools_ServiceLayer_Credentials_Win32_CredentialType_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.#ctor(System.String,System.String,System.String,Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialType)">Win32Credential(String, String, String, CredentialType)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Win32Credential(string username, string password, string target, CredentialType type)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>username</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>password</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>target</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialType.html">CredentialType</a></td>
|
||||
<td><em>type</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Description.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Description%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L142">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Description" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Description">Description</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Description { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_LastWriteTime.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.LastWriteTime%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L156">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_LastWriteTime" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.LastWriteTime">LastWriteTime</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DateTime LastWriteTime { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTime</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_LastWriteTimeUtc.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.LastWriteTimeUtc%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L163">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_LastWriteTimeUtc" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.LastWriteTimeUtc">LastWriteTimeUtc</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DateTime LastWriteTimeUtc { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTime</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Password.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Password%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L98">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Password" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Password">Password</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Password { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_PersistanceType.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.PersistanceType%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L187">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_PersistanceType" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.PersistanceType">PersistanceType</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public PersistanceType PersistanceType { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.PersistanceType.html">PersistanceType</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_SecurePassword.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.SecurePassword%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L110">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_SecurePassword" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.SecurePassword">SecurePassword</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SecureString SecurePassword { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Security.SecureString</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Target.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Target%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L128">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Target" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Target">Target</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Target { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L173">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CredentialType Type { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialType.html">CredentialType</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Username.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Username%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L86">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Username" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Username">Username</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Username { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Delete.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Delete%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L229">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Delete" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Delete">Delete()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Delete()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Dispose.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Dispose%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L56">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Dispose" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Dispose">Dispose()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Exists.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Exists%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L261">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Exists" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Exists">Exists()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Exists()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Load.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Load%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L243">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Load" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Load">Load()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Load()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Save.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Save%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L201">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential_Save" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.Save">Save()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Save()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32_Win32Credential.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Win32/Win32Credential.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,122 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Credentials.Win32
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Credentials.Win32
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials_Win32.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Win32" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Win32">Namespace Microsoft.SqlTools.ServiceLayer.Credentials.Win32
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialSet.html">CredentialSet</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.Win32Credential.html">Win32Credential</a></h4>
|
||||
<section></section>
|
||||
<h3 id="enums">Enums
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.CredentialType.html">CredentialType</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Win32.PersistanceType.html">PersistanceType</a></h4>
|
||||
<section></section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Win32.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Win32%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,121 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Credentials
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Credentials
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Credentials.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials">Namespace Microsoft.SqlTools.ServiceLayer.Credentials
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.CredentialService.html">CredentialService</a></h4>
|
||||
<section><p>Service responsible for securing credentials in a platform-neutral manner. This provides
|
||||
a generic API for read, save and delete credentials</p>
|
||||
</section>
|
||||
<h3 id="interfaces">Interfaces
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore.html">ICredentialStore</a></h4>
|
||||
<section><p>An <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.ICredentialStore.html">ICredentialStore</a> support securely saving and retrieving passwords</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,127 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ClientCapabilities
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ClientCapabilities
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_ClientCapabilities.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ClientCapabilities%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/Hosting/Contracts/ClientCapabilities.cs/#L14" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ClientCapabilities" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ClientCapabilities">Class ClientCapabilities
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Defines a class that describes the capabilities of a language
|
||||
client. At this time no specific capabilities are listed for
|
||||
clients.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ClientCapabilities</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ClientCapabilities_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ClientCapabilities</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ClientCapabilities.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ClientCapabilities%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ClientCapabilities.cs/#L14" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,184 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class CompletionOptions
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class CompletionOptions
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_CompletionOptions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.CompletionOptions%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/Hosting/Contracts/ServerCapabilities.cs/#L51" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_CompletionOptions" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.CompletionOptions">Class CompletionOptions
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">CompletionOptions</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_CompletionOptions_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CompletionOptions</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_CompletionOptions_ResolveProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.CompletionOptions.ResolveProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L53">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_CompletionOptions_ResolveProvider" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.CompletionOptions.ResolveProvider">ResolveProvider</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? ResolveProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_CompletionOptions_TriggerCharacters.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.CompletionOptions.TriggerCharacters%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L55">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_CompletionOptions_TriggerCharacters" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.CompletionOptions.TriggerCharacters">TriggerCharacters</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string[] TriggerCharacters { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span>[]</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_CompletionOptions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.CompletionOptions%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L51" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,142 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ExitNotification
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ExitNotification
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_ExitNotification.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ExitNotification%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/Hosting/Contracts/Shutdown.cs/#L25" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ExitNotification" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ExitNotification">Class ExitNotification
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Defines an event that is sent from the client to notify that
|
||||
the client is exiting and the server should as well.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ExitNotification</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ExitNotification_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ExitNotification</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ExitNotification_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ExitNotification.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Shutdown.cs/#L28">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ExitNotification_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ExitNotification.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly EventType<object> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ExitNotification.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ExitNotification%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Shutdown.cs/#L25" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,140 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class HostingErrorEvent
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class HostingErrorEvent
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_HostingErrorEvent.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorEvent%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/Hosting/Contracts/HostingErrorEvent.cs/#L21" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_HostingErrorEvent" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorEvent">Class HostingErrorEvent
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">HostingErrorEvent</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_HostingErrorEvent_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class HostingErrorEvent</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_HostingErrorEvent_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorEvent.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/HostingErrorEvent.cs/#L24">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_HostingErrorEvent_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorEvent.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly EventType<HostingErrorParams> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_HostingErrorEvent.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorEvent%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/HostingErrorEvent.cs/#L21" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,157 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class HostingErrorParams
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class HostingErrorParams
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_HostingErrorParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorParams%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/Hosting/Contracts/HostingErrorEvent.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_HostingErrorParams" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorParams">Class HostingErrorParams
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Parameters to be used for reporting hosting-level errors, such as protocol violations</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">HostingErrorParams</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_HostingErrorParams_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class HostingErrorParams</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_HostingErrorParams_Message.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorParams.Message%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/HostingErrorEvent.cs/#L18">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_HostingErrorParams_Message" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorParams.Message">Message</h4>
|
||||
<div class="markdown level1 summary"><p>The message of the error</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Message { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_HostingErrorParams.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorParams%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/HostingErrorEvent.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,157 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class InitializeError
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class InitializeError
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_InitializeError.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeError%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/Hosting/Contracts/Initialize.cs/#L37" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeError" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeError">Class InitializeError
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">InitializeError</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeError_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class InitializeError</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeError_Retry.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeError.Retry%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Initialize.cs/#L43">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeError_Retry" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeError.Retry">Retry</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether the client should retry
|
||||
sending the Initialize request after showing the error to the user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Retry { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeError.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeError%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Initialize.cs/#L37" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,204 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class InitializeRequest
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class InitializeRequest
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_InitializeRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeRequest%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/Hosting/Contracts/Initialize.cs/#L10" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeRequest" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeRequest">Class InitializeRequest
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">InitializeRequest</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeRequest_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class InitializeRequest</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeRequest_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeRequest.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Initialize.cs/#L13">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeRequest_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeRequest.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly RequestType<InitializeRequest, InitializeResult> Type</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeRequest_Capabilities.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeRequest.Capabilities%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Initialize.cs/#L26">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeRequest_Capabilities" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeRequest.Capabilities">Capabilities</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the capabilities provided by the client (editor).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ClientCapabilities Capabilities { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ClientCapabilities.html">ClientCapabilities</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeRequest_RootPath.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeRequest.RootPath%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Initialize.cs/#L21">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeRequest_RootPath" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeRequest.RootPath">RootPath</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the root path of the editor's open workspace.
|
||||
If null it is assumed that a file was opened without having
|
||||
a workspace open.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string RootPath { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeRequest%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Initialize.cs/#L10" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,156 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class InitializeResult
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class InitializeResult
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_InitializeResult.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeResult%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/Hosting/Contracts/Initialize.cs/#L29" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeResult" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeResult">Class InitializeResult
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">InitializeResult</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeResult_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class InitializeResult</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeResult_Capabilities.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeResult.Capabilities%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Initialize.cs/#L34">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeResult_Capabilities" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeResult.Capabilities">Capabilities</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the capabilities provided by the language server.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ServerCapabilities Capabilities { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.html">ServerCapabilities</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_InitializeResult.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeResult%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Initialize.cs/#L29" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,387 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ServerCapabilities
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ServerCapabilities
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_ServerCapabilities.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities%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/Hosting/Contracts/ServerCapabilities.cs/#L8" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities">Class ServerCapabilities
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ServerCapabilities</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ServerCapabilities</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_CompletionProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.CompletionProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L14">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_CompletionProvider" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.CompletionProvider">CompletionProvider</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CompletionOptions CompletionProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.CompletionOptions.html">CompletionOptions</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_DefinitionProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.DefinitionProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L18">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_DefinitionProvider" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.DefinitionProvider">DefinitionProvider</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? DefinitionProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_DocumentHighlightProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.DocumentHighlightProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L22">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_DocumentHighlightProvider" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.DocumentHighlightProvider">DocumentHighlightProvider</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? DocumentHighlightProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_DocumentSymbolProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.DocumentSymbolProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L24">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_DocumentSymbolProvider" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.DocumentSymbolProvider">DocumentSymbolProvider</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? DocumentSymbolProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_HoverProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.HoverProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L12">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_HoverProvider" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.HoverProvider">HoverProvider</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? HoverProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_ReferencesProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.ReferencesProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L20">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_ReferencesProvider" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.ReferencesProvider">ReferencesProvider</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? ReferencesProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_SignatureHelpProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.SignatureHelpProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_SignatureHelpProvider" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.SignatureHelpProvider">SignatureHelpProvider</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SignatureHelpOptions SignatureHelpProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.SignatureHelpOptions.html">SignatureHelpOptions</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_TextDocumentSync.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.TextDocumentSync%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L10">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_TextDocumentSync" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.TextDocumentSync">TextDocumentSync</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public TextDocumentSyncKind? TextDocumentSync { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.TextDocumentSyncKind.html">TextDocumentSyncKind</a>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_WorkspaceSymbolProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.WorkspaceSymbolProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L26">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities_WorkspaceSymbolProvider" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.WorkspaceSymbolProvider">WorkspaceSymbolProvider</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ? WorkspaceSymbolProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Boolean</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ServerCapabilities.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L8" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,142 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ShutdownRequest
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ShutdownRequest
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_ShutdownRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ShutdownRequest%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/Hosting/Contracts/Shutdown.cs/#L14" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ShutdownRequest" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ShutdownRequest">Class ShutdownRequest
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Defines a message that is sent from the client to request
|
||||
that the server shut down.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ShutdownRequest</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ShutdownRequest_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ShutdownRequest</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ShutdownRequest_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ShutdownRequest.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Shutdown.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ShutdownRequest_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ShutdownRequest.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly RequestType<object, object> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_ShutdownRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ShutdownRequest%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/Shutdown.cs/#L14" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,155 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class SignatureHelpOptions
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class SignatureHelpOptions
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_SignatureHelpOptions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.SignatureHelpOptions%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/Hosting/Contracts/ServerCapabilities.cs/#L58" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_SignatureHelpOptions" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.SignatureHelpOptions">Class SignatureHelpOptions
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">SignatureHelpOptions</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_SignatureHelpOptions_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SignatureHelpOptions</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_SignatureHelpOptions_TriggerCharacters.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.SignatureHelpOptions.TriggerCharacters%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L60">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_SignatureHelpOptions_TriggerCharacters" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.SignatureHelpOptions.TriggerCharacters">TriggerCharacters</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string[] TriggerCharacters { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span>[]</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_SignatureHelpOptions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.SignatureHelpOptions%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L58" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,147 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Enum TextDocumentSyncKind
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Enum TextDocumentSyncKind
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<div class="col-md-10">
|
||||
<article class="content wrap" id="_content">
|
||||
|
||||
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_TextDocumentSyncKind" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.TextDocumentSyncKind">Enum TextDocumentSyncKind
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Defines the document synchronization strategies that a server may support.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_TextDocumentSyncKind_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum TextDocumentSyncKind</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_TextDocumentSyncKind_Full">Full</td>
|
||||
<td><p>Indicates that document changes are always sent with the full content.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_TextDocumentSyncKind_Incremental">Incremental</td>
|
||||
<td><p>Indicates that document changes are sent as incremental changes after
|
||||
the initial document content has been sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_TextDocumentSyncKind_None">None</td>
|
||||
<td><p>Indicates that documents should not be synced at all.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</thead></thead></table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_TextDocumentSyncKind.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.TextDocumentSyncKind%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/ServerCapabilities.cs/#L32" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,142 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class VersionRequest
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class VersionRequest
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts_VersionRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.VersionRequest%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/Hosting/Contracts/VersionRequest.cs/#L14" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_VersionRequest" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.VersionRequest">Class VersionRequest
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Defines a message that is sent from the client to request
|
||||
the version of the server.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">VersionRequest</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_VersionRequest_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class VersionRequest</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_VersionRequest_Type.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.VersionRequest.Type%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/VersionRequest.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_VersionRequest_Type" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.VersionRequest.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly RequestType<object, string> Type</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts_VersionRequest.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.VersionRequest%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Contracts/VersionRequest.cs/#L14" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,151 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Contracts
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Contracts
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Contracts.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Contracts" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts">Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Contracts
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ClientCapabilities.html">ClientCapabilities</a></h4>
|
||||
<section><p>Defines a class that describes the capabilities of a language
|
||||
client. At this time no specific capabilities are listed for
|
||||
clients.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.CompletionOptions.html">CompletionOptions</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ExitNotification.html">ExitNotification</a></h4>
|
||||
<section><p>Defines an event that is sent from the client to notify that
|
||||
the client is exiting and the server should as well.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorEvent.html">HostingErrorEvent</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.HostingErrorParams.html">HostingErrorParams</a></h4>
|
||||
<section><p>Parameters to be used for reporting hosting-level errors, such as protocol violations</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeError.html">InitializeError</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeRequest.html">InitializeRequest</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.InitializeResult.html">InitializeResult</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ServerCapabilities.html">ServerCapabilities</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.ShutdownRequest.html">ShutdownRequest</a></h4>
|
||||
<section><p>Defines a message that is sent from the client to request
|
||||
that the server shut down.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.SignatureHelpOptions.html">SignatureHelpOptions</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.VersionRequest.html">VersionRequest</a></h4>
|
||||
<section><p>Defines a message that is sent from the client to request
|
||||
the version of the server.</p>
|
||||
</section>
|
||||
<h3 id="enums">Enums
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Contracts.TextDocumentSyncKind.html">TextDocumentSyncKind</a></h4>
|
||||
<section><p>Defines the document synchronization strategies that a server may support.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Contracts.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Contracts%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,352 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ChannelBase
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ChannelBase
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Channel_ChannelBase.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase%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/Hosting/Protocol/Channel/ChannelBase.cs/#L15" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase">Class ChannelBase
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Defines a base implementation for servers and their clients over a
|
||||
single kind of communication channel.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ChannelBase</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public abstract class ChannelBase</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_IsConnected.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.IsConnected%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L20">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_IsConnected" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.IsConnected">IsConnected</h4>
|
||||
<div class="markdown level1 summary"><p>Gets a boolean that is true if the channel is connected or false if not.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsConnected { get; protected set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_MessageReader.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.MessageReader%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L25">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_MessageReader" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.MessageReader">MessageReader</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the MessageReader for reading messages from the channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MessageReader MessageReader { get; protected set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.html">MessageReader</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_MessageWriter.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.MessageWriter%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L30">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_MessageWriter" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.MessageWriter">MessageWriter</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the MessageWriter for writing messages to the channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MessageWriter MessageWriter { get; protected set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.html">MessageWriter</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Initialize_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Initialize(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L73">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Initialize_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Initialize(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer)">Initialize(IMessageSerializer)</h4>
|
||||
<div class="markdown level1 summary"><p>A method to be implemented by subclasses to handle the
|
||||
actual initialization of the channel and the creation and
|
||||
assignment of the MessageReader and MessageWriter properties.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected abstract void Initialize(IMessageSerializer messageSerializer)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.html">IMessageSerializer</a></td>
|
||||
<td><em>messageSerializer</em></td>
|
||||
<td><p>The IMessageSerializer to use for message serialization.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Shutdown.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Shutdown%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L79">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Shutdown" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Shutdown">Shutdown()</h4>
|
||||
<div class="markdown level1 summary"><p>A method to be implemented by subclasses to handle shutdown
|
||||
of the channel once Stop is called.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected abstract void Shutdown()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Start_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Start(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L36">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Start_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Start(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType)">Start(MessageProtocolType)</h4>
|
||||
<div class="markdown level1 summary"><p>Starts the channel and initializes the MessageDispatcher.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Start(MessageProtocolType messageProtocolType)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType.html">MessageProtocolType</a></td>
|
||||
<td><em>messageProtocolType</em></td>
|
||||
<td><p>The type of message protocol used by the channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Stop.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Stop%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L62">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Stop" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Stop">Stop()</h4>
|
||||
<div class="markdown level1 summary"><p>Stops the channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Stop()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_WaitForConnection.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.WaitForConnection%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L57">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_WaitForConnection" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.WaitForConnection">WaitForConnection()</h4>
|
||||
<div class="markdown level1 summary"><p>Returns a Task that allows the consumer of the ChannelBase
|
||||
implementation to wait until a connection has been made to
|
||||
the opposite endpoint whether it's a client or server.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public abstract Task WaitForConnection()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td><p>A Task to be awaited until a connection is made.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L15" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,277 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class StdioClientChannel
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class StdioClientChannel
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Channel_StdioClientChannel.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel%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/Hosting/Protocol/Channel/StdioClientChannel.cs/#L19" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel">Class StdioClientChannel
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Provides a client implementation for the standard I/O channel.
|
||||
Launches the server process and then attaches to its console
|
||||
streams.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.html">ChannelBase</a></div>
|
||||
<div class="level2"><span class="xref">StdioClientChannel</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class StdioClientChannel : ChannelBase</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel__ctor_System_String_System_String___.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.%23ctor(System.String%2CSystem.String%5B%5D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/StdioClientChannel.cs/#L38">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel__ctor_System_String_System_String___" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.#ctor(System.String,System.String[])">StdioClientChannel(String, String[])</h4>
|
||||
<div class="markdown level1 summary"><p>Initializes an instance of the StdioClient.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public StdioClientChannel(string serverProcessPath, params string[] serverProcessArguments)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>serverProcessPath</em></td>
|
||||
<td><p>The full path to the server process executable.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span>[]</td>
|
||||
<td><em>serverProcessArguments</em></td>
|
||||
<td><p>Optional arguments to pass to the service process executable.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel_ProcessId.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.ProcessId%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/StdioClientChannel.cs/#L31">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel_ProcessId" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.ProcessId">ProcessId</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the process ID of the server process.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int ProcessId { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel_Initialize_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.Initialize(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/StdioClientChannel.cs/#L53">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel_Initialize_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.Initialize(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer)">Initialize(IMessageSerializer)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override void Initialize(IMessageSerializer messageSerializer)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.html">IMessageSerializer</a></td>
|
||||
<td><em>messageSerializer</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel_Shutdown.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.Shutdown%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/StdioClientChannel.cs/#L99">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel_Shutdown" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.Shutdown">Shutdown()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override void Shutdown()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel_WaitForConnection.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.WaitForConnection%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/StdioClientChannel.cs/#L93">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel_WaitForConnection" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.WaitForConnection">WaitForConnection()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override Task WaitForConnection()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioClientChannel.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/StdioClientChannel.cs/#L19" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,204 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class StdioServerChannel
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class StdioServerChannel
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Channel_StdioServerChannel.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel%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/Hosting/Protocol/Channel/StdioServerChannel.cs/#L18" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioServerChannel" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel">Class StdioServerChannel
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Provides a server implementation for the standard I/O channel.
|
||||
When started in a process, attaches to the console I/O streams
|
||||
to communicate with the client that launched the process.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.html">ChannelBase</a></div>
|
||||
<div class="level2"><span class="xref">StdioServerChannel</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioServerChannel_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class StdioServerChannel : ChannelBase</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioServerChannel_Initialize_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel.Initialize(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/StdioServerChannel.cs/#L23">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioServerChannel_Initialize_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel.Initialize(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer)">Initialize(IMessageSerializer)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override void Initialize(IMessageSerializer messageSerializer)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.html">IMessageSerializer</a></td>
|
||||
<td><em>messageSerializer</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioServerChannel_Shutdown.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel.Shutdown%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/StdioServerChannel.cs/#L55">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioServerChannel_Shutdown" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel.Shutdown">Shutdown()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override void Shutdown()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioServerChannel_WaitForConnection.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel.WaitForConnection%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/StdioServerChannel.cs/#L49">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioServerChannel_WaitForConnection" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel.WaitForConnection">WaitForConnection()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override Task WaitForConnection()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_StdioServerChannel.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/StdioServerChannel.cs/#L18" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,126 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Channel.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel">Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.html">ChannelBase</a></h4>
|
||||
<section><p>Defines a base implementation for servers and their clients over a
|
||||
single kind of communication channel.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.html">StdioClientChannel</a></h4>
|
||||
<section><p>Provides a client implementation for the standard I/O channel.
|
||||
Launches the server process and then attaches to its console
|
||||
streams.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel.html">StdioServerChannel</a></h4>
|
||||
<section><p>Provides a server implementation for the standard I/O channel.
|
||||
When started in a process, attaches to the console I/O streams
|
||||
to communicate with the client that launched the process.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,168 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class Constants
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class Constants
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Constants.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Constants%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/Hosting/Protocol/Constants.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Constants" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Constants">Class Constants
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">Constants</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Constants_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class Constants</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Constants_ContentLengthFormatString.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Constants.ContentLengthFormatString%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Constants.cs/#L13">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Constants_ContentLengthFormatString" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Constants.ContentLengthFormatString">ContentLengthFormatString</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string ContentLengthFormatString = "Content-Length: {0}\r\n\r\n"</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Constants_JsonSerializerSettings.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Constants.JsonSerializerSettings%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Constants.cs/#L14">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Constants_JsonSerializerSettings" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Constants.JsonSerializerSettings">JsonSerializerSettings</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly JsonSerializerSettings JsonSerializerSettings</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Constants_SqlLoginAuthenticationType.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Constants.SqlLoginAuthenticationType%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Constants.cs/#L16">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Constants_SqlLoginAuthenticationType" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Constants.SqlLoginAuthenticationType">SqlLoginAuthenticationType</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static readonly string SqlLoginAuthenticationType</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Constants.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Constants%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Constants.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,208 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class EventType<TParams>
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class EventType<TParams>
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Contracts_EventType_1.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%601%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/Hosting/Protocol/Contracts/EventType.cs/#L12" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType_1" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType`1">Class EventType<TParams>
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Defines an event type with a particular method name.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">EventType<TParams></span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType_1_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class EventType<TParams></code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType_1_MethodName.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%601.MethodName%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/EventType.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType_1_MethodName" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType`1.MethodName">MethodName</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the method name for the event type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string MethodName { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType_1_Create_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%601.Create(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/EventType.cs/#L24">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType_1_Create_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType`1.Create(System.String)">Create(String)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates an EventType instance with the given parameter type and method name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static EventType<TParams> Create(string methodName)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>methodName</em></td>
|
||||
<td><p>The method name of the event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><p>A new EventType instance for the defined type.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType_1.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%601%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/EventType.cs/#L12" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,548 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class Message
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class Message
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Contracts_Message.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message%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/Hosting/Protocol/Contracts/Message.cs/#L25" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message">Class Message
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Provides common details for protocol messages of any format.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">Message</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Message</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Contents.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Contents%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L46">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Contents" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Contents">Contents</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a JToken containing the contents of the message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public JToken Contents { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JToken</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Error.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Error%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L51">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Error" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Error">Error</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a JToken containing error details.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public JToken Error { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JToken</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Id.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Id%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L36">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Id" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Id">Id</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the message's sequence ID.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Id { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_MessageType.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.MessageType%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L31">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_MessageType" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.MessageType">MessageType</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the message type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MessageType MessageType { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.MessageType.html">MessageType</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Method.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Method%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L41">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Method" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Method">Method</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the message's method/command name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Method { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Event_System_String_Newtonsoft_Json_Linq_JToken_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Event(System.String%2CNewtonsoft.Json.Linq.JToken)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L125">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Event_System_String_Newtonsoft_Json_Linq_JToken_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Event(System.String,Newtonsoft.Json.Linq.JToken)">Event(String, JToken)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates a message with an Event type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Message Event(string method, JToken contents)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>method</em></td>
|
||||
<td><p>The method name of the event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JToken</span></td>
|
||||
<td><em>contents</em></td>
|
||||
<td><p>The contents of the event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><p>A message with an Event type.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Request_System_String_System_String_Newtonsoft_Json_Linq_JToken_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Request(System.String%2CSystem.String%2CNewtonsoft.Json.Linq.JToken)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L72">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Request_System_String_System_String_Newtonsoft_Json_Linq_JToken_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Request(System.String,System.String,Newtonsoft.Json.Linq.JToken)">Request(String, String, JToken)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates a message with a Request type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Message Request(string id, string method, JToken contents)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>id</em></td>
|
||||
<td><p>The sequence ID of the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>method</em></td>
|
||||
<td><p>The method name of the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JToken</span></td>
|
||||
<td><em>contents</em></td>
|
||||
<td><p>The contents of the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><p>A message with a Request type.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Response_System_String_System_String_Newtonsoft_Json_Linq_JToken_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Response(System.String%2CSystem.String%2CNewtonsoft.Json.Linq.JToken)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L90">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Response_System_String_System_String_Newtonsoft_Json_Linq_JToken_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Response(System.String,System.String,Newtonsoft.Json.Linq.JToken)">Response(String, String, JToken)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates a message with a Response type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Message Response(string id, string method, JToken contents)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>id</em></td>
|
||||
<td><p>The sequence ID of the original request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>method</em></td>
|
||||
<td><p>The method name of the original request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JToken</span></td>
|
||||
<td><em>contents</em></td>
|
||||
<td><p>The contents of the response.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><p>A message with a Response type.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_ResponseError_System_String_System_String_Newtonsoft_Json_Linq_JToken_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.ResponseError(System.String%2CSystem.String%2CNewtonsoft.Json.Linq.JToken)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L108">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_ResponseError_System_String_System_String_Newtonsoft_Json_Linq_JToken_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.ResponseError(System.String,System.String,Newtonsoft.Json.Linq.JToken)">ResponseError(String, String, JToken)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates a message with a Response type and error details.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Message ResponseError(string id, string method, JToken error)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>id</em></td>
|
||||
<td><p>The sequence ID of the original request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>method</em></td>
|
||||
<td><p>The method name of the original request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JToken</span></td>
|
||||
<td><em>error</em></td>
|
||||
<td><p>The error details of the response.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><p>A message with a Response type and error details.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Unknown.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Unknown%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L57">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Unknown" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Unknown">Unknown()</h4>
|
||||
<div class="markdown level1 summary"><p>Creates a message with an Unknown type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Message Unknown()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><p>A message with Unknown type.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L25" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,147 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Enum MessageType
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Enum MessageType
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<div class="col-md-10">
|
||||
<article class="content wrap" id="_content">
|
||||
|
||||
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_MessageType" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.MessageType">Enum MessageType
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Defines all possible message types.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_MessageType_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum MessageType</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_MessageType_Event">Event</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_MessageType_Request">Request</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_MessageType_Response">Response</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_MessageType_Unknown">Unknown</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</thead></thead></table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_MessageType.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.MessageType%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L14" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,203 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class RequestType<TParams, TResult>
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class RequestType<TParams, TResult>
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Contracts_RequestType_2.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%602%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/Hosting/Protocol/Contracts/RequestType.cs/#L10" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType_2" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType`2">Class RequestType<TParams, TResult>
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">RequestType<TParams, TResult></span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType_2_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class RequestType<TParams, TResult></code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType_2_MethodName.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%602.MethodName%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/RequestType.cs/#L13">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType_2_MethodName" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType`2.MethodName">MethodName</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string MethodName { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType_2_Create_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%602.Create(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/RequestType.cs/#L15">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType_2_Create_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType`2.Create(System.String)">Create(String)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static RequestType<TParams, TResult> Create(string typeName)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>typeName</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType_2.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%602%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/RequestType.cs/#L10" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,125 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Contracts.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts">Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></h4>
|
||||
<section><p>Defines an event type with a particular method name.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></h4>
|
||||
<section><p>Provides common details for protocol messages of any format.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></h4>
|
||||
<section></section>
|
||||
<h3 id="enums">Enums
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.MessageType.html">MessageType</a></h4>
|
||||
<section><p>Defines all possible message types.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,227 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class EventContext
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class EventContext
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_EventContext.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext%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/Hosting/Protocol/EventContext.cs/#L15" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext">Class EventContext
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Provides context for a received event so that handlers
|
||||
can write events back to the channel.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">EventContext</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class EventContext</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext__ctor.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.%23ctor%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/EventContext.cs/#L22">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.#ctor">EventContext()</h4>
|
||||
<div class="markdown level1 summary"><p>Parameterless constructor required for mocking</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public EventContext()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.%23ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/EventContext.cs/#L24">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.#ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter)">EventContext(MessageWriter)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public EventContext(MessageWriter messageWriter)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.html">MessageWriter</a></td>
|
||||
<td><em>messageWriter</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.SendEvent%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2C%60%600)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/EventContext.cs/#L29">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.SendEvent``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},``0)">SendEvent<TParams>(EventType<TParams>, TParams)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task SendEvent<TParams>(EventType<TParams> eventType, TParams eventParams)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TParams</span></td>
|
||||
<td><em>eventParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/EventContext.cs/#L15" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,228 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Interface IMessageSender
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Interface IMessageSender
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_IMessageSender.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IMessageSender%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/Hosting/Protocol/IMessageSender.cs/#L11" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IMessageSender" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IMessageSender">Interface IMessageSender
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IMessageSender_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface IMessageSender</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IMessageSender_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IMessageSender.SendEvent%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2C%60%600)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/IMessageSender.cs/#L13">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IMessageSender_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IMessageSender.SendEvent``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},``0)">SendEvent<TParams>(EventType<TParams>, TParams)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">Task SendEvent<TParams>(EventType<TParams> eventType, TParams eventParams)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TParams</span></td>
|
||||
<td><em>eventParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IMessageSender_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_System_Boolean_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IMessageSender.SendRequest%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2C%60%600%2CSystem.Boolean)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/IMessageSender.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IMessageSender_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IMessageSender.SendRequest``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},``0,System.Boolean)">SendRequest<TParams, TResult>(RequestType<TParams, TResult>, TParams, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">Task<TResult> SendRequest<TParams, TResult>(RequestType<TParams, TResult> requestType, TParams requestParams, bool waitForResponse)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
||||
<td><em>requestType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TParams</span></td>
|
||||
<td><em>requestParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><em>waitForResponse</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><TResult></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IMessageSender.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IMessageSender%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/IMessageSender.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,237 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Interface IProtocolEndpoint
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Interface IProtocolEndpoint
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_IProtocolEndpoint.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint%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/Hosting/Protocol/IProtocolEndpoint.cs/#L17" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint">Interface IProtocolEndpoint
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>A ProtocolEndpoint is used for inter-process communication. Services can register to
|
||||
respond to requests and events, send their own requests, and listen for notifications
|
||||
sent by the other side of the endpoint</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface IProtocolEndpoint : IMessageSender</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.SetEventHandler%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext%2CSystem.Threading.Tasks.Task%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/IProtocolEndpoint.cs/#L23">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.SetEventHandler``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext,System.Threading.Tasks.Task})">SetEventHandler<TParams>(EventType<TParams>, Func<TParams, EventContext, Task>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">void SetEventHandler<TParams>(EventType<TParams> eventType, Func<TParams, EventContext, Task> eventHandler)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
||||
<td><em>eventHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__System_Boolean_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.SetEventHandler%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext%2CSystem.Threading.Tasks.Task%7D%2CSystem.Boolean)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/IProtocolEndpoint.cs/#L27">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.SetEventHandler``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext,System.Threading.Tasks.Task},System.Boolean)">SetEventHandler<TParams>(EventType<TParams>, Func<TParams, EventContext, Task>, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">void SetEventHandler<TParams>(EventType<TParams> eventType, Func<TParams, EventContext, Task> eventHandler, bool overrideExisting)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
||||
<td><em>eventHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><em>overrideExisting</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.SetRequestHandler%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7B%60%601%7D%2CSystem.Threading.Tasks.Task%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/IProtocolEndpoint.cs/#L19">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.SetRequestHandler``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{``1},System.Threading.Tasks.Task})">SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult>, Func<TParams, RequestContext<TResult>, Task>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">void SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult> requestType, Func<TParams, RequestContext<TResult>, Task> requestHandler)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
||||
<td><em>requestType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><TResult>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
||||
<td><em>requestHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/IProtocolEndpoint.cs/#L17" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,588 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class MessageDispatcher
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class MessageDispatcher
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_MessageDispatcher.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher%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/Hosting/Protocol/MessageDispatcher.cs/#L18" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher">Class MessageDispatcher
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">MessageDispatcher</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class MessageDispatcher</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.%23ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L63">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.#ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase)">MessageDispatcher(ChannelBase)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MessageDispatcher(ChannelBase protocolChannel)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.html">ChannelBase</a></td>
|
||||
<td><em>protocolChannel</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_InMessageLoopThread.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.InMessageLoopThread%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L43">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_InMessageLoopThread" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.InMessageLoopThread">InMessageLoopThread</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool InMessageLoopThread { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_MessageReader.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.MessageReader%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L54">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_MessageReader" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.MessageReader">MessageReader</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected MessageReader MessageReader { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.html">MessageReader</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_MessageWriter.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.MessageWriter%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L56">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_MessageWriter" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.MessageWriter">MessageWriter</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected MessageWriter MessageWriter { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.html">MessageWriter</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SynchronizationContext.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SynchronizationContext%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L41">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SynchronizationContext" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SynchronizationContext">SynchronizationContext</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SynchronizationContext SynchronizationContext { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.SynchronizationContext</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_DispatchMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.DispatchMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L257">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_DispatchMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.DispatchMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter)">DispatchMessage(Message, MessageWriter)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected Task DispatchMessage(Message messageToDispatch, MessageWriter messageWriter)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><em>messageToDispatch</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.html">MessageWriter</a></td>
|
||||
<td><em>messageWriter</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_OnUnhandledException_System_Exception_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.OnUnhandledException(System.Exception)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L191">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_OnUnhandledException_System_Exception_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.OnUnhandledException(System.Exception)">OnUnhandledException(Exception)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected void OnUnhandledException(Exception unhandledException)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Exception</span></td>
|
||||
<td><em>unhandledException</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetEventHandler%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext%2CSystem.Threading.Tasks.Task%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L136">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetEventHandler``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext,System.Threading.Tasks.Task})">SetEventHandler<TParams>(EventType<TParams>, Func<TParams, EventContext, Task>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetEventHandler<TParams>(EventType<TParams> eventType, Func<TParams, EventContext, Task> eventHandler)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
||||
<td><em>eventHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__System_Boolean_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetEventHandler%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext%2CSystem.Threading.Tasks.Task%7D%2CSystem.Boolean)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L146">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetEventHandler``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext,System.Threading.Tasks.Task},System.Boolean)">SetEventHandler<TParams>(EventType<TParams>, Func<TParams, EventContext, Task>, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetEventHandler<TParams>(EventType<TParams> eventType, Func<TParams, EventContext, Task> eventHandler, bool overrideExisting)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
||||
<td><em>eventHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><em>overrideExisting</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetRequestHandler%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7B%60%601%7D%2CSystem.Threading.Tasks.Task%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L95">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetRequestHandler``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{``1},System.Threading.Tasks.Task})">SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult>, Func<TParams, RequestContext<TResult>, Task>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult> requestType, Func<TParams, RequestContext<TResult>, Task> requestHandler)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
||||
<td><em>requestType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><TResult>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
||||
<td><em>requestHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__System_Boolean_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetRequestHandler%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7B%60%601%7D%2CSystem.Threading.Tasks.Task%7D%2CSystem.Boolean)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L105">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetRequestHandler``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{``1},System.Threading.Tasks.Task},System.Boolean)">SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult>, Func<TParams, RequestContext<TResult>, Task>, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult> requestType, Func<TParams, RequestContext<TResult>, Task> requestHandler, bool overrideExisting)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
||||
<td><em>requestType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><TResult>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
||||
<td><em>requestHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><em>overrideExisting</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetResponseHandler_System_Action_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetResponseHandler(System.Action%7BMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L180">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetResponseHandler_System_Action_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message__" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetResponseHandler(System.Action{Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message})">SetResponseHandler(Action<Message>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetResponseHandler(Action<Message> responseHandler)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a>></td>
|
||||
<td><em>responseHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_Start.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.Start%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L74">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_Start" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.Start">Start()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Start()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_Stop.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.Stop%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L85">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_Stop" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.Stop">Stop()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Stop()</code></pre>
|
||||
</div>
|
||||
<h3 id="events">Events
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_UnhandledException.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.UnhandledException%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L189">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_UnhandledException" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.UnhandledException">UnhandledException</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event EventHandler<Exception> UnhandledException</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L18" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,199 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class MessageParseException
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class MessageParseException
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_MessageParseException.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageParseException%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/Hosting/Protocol/MessageParseException.cs/#L10" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageParseException" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageParseException">Class MessageParseException
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">System.Exception</span></div>
|
||||
<div class="level2"><span class="xref">MessageParseException</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageParseException_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class MessageParseException : Exception</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageParseException__ctor_System_String_System_String_System_Object___.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageParseException.%23ctor(System.String%2CSystem.String%2CSystem.Object%5B%5D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageParseException.cs/#L14">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageParseException__ctor_System_String_System_String_System_Object___" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageParseException.#ctor(System.String,System.String,System.Object[])">MessageParseException(String, String, Object[])</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MessageParseException(string originalMessageText, string errorMessage, params object[] errorMessageArgs)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>originalMessageText</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>errorMessage</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Object</span>[]</td>
|
||||
<td><em>errorMessageArgs</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageParseException_OriginalMessageText.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageParseException.OriginalMessageText%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageParseException.cs/#L12">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageParseException_OriginalMessageText" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageParseException.OriginalMessageText">OriginalMessageText</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string OriginalMessageText { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageParseException.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageParseException%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageParseException.cs/#L10" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,141 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Enum MessageProtocolType
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Enum MessageProtocolType
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<div class="col-md-10">
|
||||
<article class="content wrap" id="_content">
|
||||
|
||||
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType">Enum MessageProtocolType
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Defines the possible message protocol types.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum MessageProtocolType</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType_DebugAdapter">DebugAdapter</td>
|
||||
<td><p>Identifies the debug adapter message protocol.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType_LanguageServer">LanguageServer</td>
|
||||
<td><p>Identifies the language server message protocol.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</thead></thead></table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageProtocolType.cs/#L11" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,228 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class MessageReader
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class MessageReader
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_MessageReader.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader%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/Hosting/Protocol/MessageReader.cs/#L18" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader">Class MessageReader
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">MessageReader</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class MessageReader</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader__ctor_System_IO_Stream_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_System_Text_Encoding_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.%23ctor(System.IO.Stream%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer%2CSystem.Text.Encoding)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageReader.cs/#L52">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader__ctor_System_IO_Stream_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_System_Text_Encoding_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.#ctor(System.IO.Stream,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer,System.Text.Encoding)">MessageReader(Stream, IMessageSerializer, Encoding)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MessageReader(Stream inputStream, IMessageSerializer messageSerializer, Encoding messageEncoding = null)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><em>inputStream</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.html">IMessageSerializer</a></td>
|
||||
<td><em>messageSerializer</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Text.Encoding</span></td>
|
||||
<td><em>messageEncoding</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader_BufferResizeTrigger.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.BufferResizeTrigger%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageReader.cs/#L23">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader_BufferResizeTrigger" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.BufferResizeTrigger">BufferResizeTrigger</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const double BufferResizeTrigger = 0.25</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader_DefaultBufferSize.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.DefaultBufferSize%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageReader.cs/#L22">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader_DefaultBufferSize" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.DefaultBufferSize">DefaultBufferSize</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int DefaultBufferSize = 8192</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader_ReadMessage.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.ReadMessage%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageReader.cs/#L76">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader_ReadMessage" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.ReadMessage">ReadMessage()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task<Message> ReadMessage()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageReader.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageReader.cs/#L18" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,373 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class MessageWriter
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class MessageWriter
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_MessageWriter.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter%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/Hosting/Protocol/MessageWriter.cs/#L17" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter">Class MessageWriter
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">MessageWriter</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class MessageWriter</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter__ctor_System_IO_Stream_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.%23ctor(System.IO.Stream%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageWriter.cs/#L33">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter__ctor_System_IO_Stream_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.#ctor(System.IO.Stream,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer)">MessageWriter(Stream, IMessageSerializer)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MessageWriter(Stream outputStream, IMessageSerializer messageSerializer)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><em>outputStream</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.html">IMessageSerializer</a></td>
|
||||
<td><em>messageSerializer</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_WriteEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.WriteEvent%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2C%60%600)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageWriter.cs/#L126">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_WriteEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.WriteEvent``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},``0)">WriteEvent<TParams>(EventType<TParams>, TParams)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task WriteEvent<TParams>(EventType<TParams> eventType, TParams eventParams)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TParams</span></td>
|
||||
<td><em>eventParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_WriteMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.WriteMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageWriter.cs/#L50">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_WriteMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.WriteMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message)">WriteMessage(Message)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task WriteMessage(Message messageToWrite)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><em>messageToWrite</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_WriteRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_System_Int32_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.WriteRequest%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2C%60%600%2CSystem.Int32)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageWriter.cs/#L93">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_WriteRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.WriteRequest``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},``0,System.Int32)">WriteRequest<TParams, TResult>(RequestType<TParams, TResult>, TParams, Int32)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task WriteRequest<TParams, TResult>(RequestType<TParams, TResult> requestType, TParams requestParams, int requestId)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
||||
<td><em>requestType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TParams</span></td>
|
||||
<td><em>requestParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>requestId</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_WriteResponse__1___0_System_String_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.WriteResponse%60%601(%60%600%2CSystem.String%2CSystem.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageWriter.cs/#L111">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_WriteResponse__1___0_System_String_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.WriteResponse``1(``0,System.String,System.String)">WriteResponse<TResult>(TResult, String, String)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task WriteResponse<TResult>(TResult resultContent, string method, string requestId)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">TResult</span></td>
|
||||
<td><em>resultContent</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>method</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>requestId</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageWriter.cs/#L17" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,641 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ProtocolEndpoint
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ProtocolEndpoint
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_ProtocolEndpoint.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint%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/Hosting/Protocol/ProtocolEndpoint.cs/#L19" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint">Class ProtocolEndpoint
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Provides behavior for a client or server endpoint that
|
||||
communicates using the specified protocol.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ProtocolEndpoint</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ProtocolEndpoint : IProtocolEndpoint, IMessageSender</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.%23ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L48">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.#ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType)">ProtocolEndpoint(ChannelBase, MessageProtocolType)</h4>
|
||||
<div class="markdown level1 summary"><p>Initializes an instance of the protocol server using the
|
||||
specified channel for communication.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ProtocolEndpoint(ChannelBase protocolChannel, MessageProtocolType messageProtocolType)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.html">ChannelBase</a></td>
|
||||
<td><em>protocolChannel</em></td>
|
||||
<td><p>The channel to use for communication with the connected endpoint.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType.html">MessageProtocolType</a></td>
|
||||
<td><em>messageProtocolType</em></td>
|
||||
<td><p>The type of message protocol used by the endpoint.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_MessageDispatcher.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.MessageDispatcher%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L36">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_MessageDispatcher" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.MessageDispatcher">MessageDispatcher</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the MessageDispatcher which allows registration of
|
||||
handlers for requests, responses, and events that are
|
||||
transmitted through the channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected MessageDispatcher MessageDispatcher { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.html">MessageDispatcher</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnConnect.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnConnect%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L284">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnConnect" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnConnect">OnConnect()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected virtual Task OnConnect()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStart.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnStart%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L279">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStart" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnStart">OnStart()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected virtual Task OnStart()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStop.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnStop%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L289">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStop" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnStop">OnStop()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected virtual Task OnStop()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendEvent%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2C%60%600)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L193">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendEvent``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},``0)">SendEvent<TParams>(EventType<TParams>, TParams)</h4>
|
||||
<div class="markdown level1 summary"><p>Sends an event to the channel's endpoint.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task SendEvent<TParams>(EventType<TParams> eventType, TParams eventParams)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td><p>The type of event being sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TParams</span></td>
|
||||
<td><em>eventParams</em></td>
|
||||
<td><p>The event parameters being sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td><p>A Task that tracks completion of the send operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendRequest%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2C%60%600)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L136">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendRequest``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},``0)">SendRequest<TParams, TResult>(RequestType<TParams, TResult>, TParams)</h4>
|
||||
<div class="markdown level1 summary"><p>Sends a request to the server</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task<TResult> SendRequest<TParams, TResult>(RequestType<TParams, TResult> requestType, TParams requestParams)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
||||
<td><em>requestType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TParams</span></td>
|
||||
<td><em>requestParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><TResult></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_System_Boolean_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendRequest%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2C%60%600%2CSystem.Boolean)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L143">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendRequest``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},``0,System.Boolean)">SendRequest<TParams, TResult>(RequestType<TParams, TResult>, TParams, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task<TResult> SendRequest<TParams, TResult>(RequestType<TParams, TResult> requestType, TParams requestParams, bool waitForResponse)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
||||
<td><em>requestType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TParams</span></td>
|
||||
<td><em>requestParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><em>waitForResponse</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><TResult></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetEventHandler%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext%2CSystem.Threading.Tasks.Task%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L243">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetEventHandler``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext,System.Threading.Tasks.Task})">SetEventHandler<TParams>(EventType<TParams>, Func<TParams, EventContext, Task>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetEventHandler<TParams>(EventType<TParams> eventType, Func<TParams, EventContext, Task> eventHandler)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
||||
<td><em>eventHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__System_Boolean_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetEventHandler%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext%2CSystem.Threading.Tasks.Task%7D%2CSystem.Boolean)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L253">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetEventHandler``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext,System.Threading.Tasks.Task},System.Boolean)">SetEventHandler<TParams>(EventType<TParams>, Func<TParams, EventContext, Task>, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetEventHandler<TParams>(EventType<TParams> eventType, Func<TParams, EventContext, Task> eventHandler, bool overrideExisting)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
||||
<td><em>eventHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><em>overrideExisting</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetRequestHandler%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7B%60%601%7D%2CSystem.Threading.Tasks.Task%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L234">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetRequestHandler``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{``1},System.Threading.Tasks.Task})">SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult>, Func<TParams, RequestContext<TResult>, Task>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult> requestType, Func<TParams, RequestContext<TResult>, Task> requestHandler)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
||||
<td><em>requestType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><TResult>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
||||
<td><em>requestHandler</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Start.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.Start%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L61">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Start" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.Start">Start()</h4>
|
||||
<div class="markdown level1 summary"><p>Starts the language server client and sends the Initialize method.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task Start()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td><p>A Task that can be awaited for initialization to complete.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Stop.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.Stop%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L104">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Stop" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.Stop">Stop()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task Stop()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_WaitForExit.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.WaitForExit%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L98">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_WaitForExit" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.WaitForExit">WaitForExit()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void WaitForExit()</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L19" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,321 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class RequestContext<TResult>
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class RequestContext<TResult>
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_RequestContext_1.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%601%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/Hosting/Protocol/RequestContext.cs/#L12" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext`1">Class RequestContext<TResult>
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">RequestContext<TResult></span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class RequestContext<TResult></code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1__ctor.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%601.%23ctor%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/RequestContext.cs/#L23">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext`1.#ctor">RequestContext()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public RequestContext()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%601.%23ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/RequestContext.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext`1.#ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter)">RequestContext(Message, MessageWriter)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public RequestContext(Message requestMessage, MessageWriter messageWriter)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><em>requestMessage</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.html">MessageWriter</a></td>
|
||||
<td><em>messageWriter</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1_SendError_System_Object_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%601.SendError(System.Object)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/RequestContext.cs/#L40">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1_SendError_System_Object_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext`1.SendError(System.Object)">SendError(Object)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public virtual Task SendError(object errorDetails)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Object</span></td>
|
||||
<td><em>errorDetails</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%601.SendEvent%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2C%60%600)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/RequestContext.cs/#L33">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext`1.SendEvent``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},``0)">SendEvent<TParams>(EventType<TParams>, TParams)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public virtual Task SendEvent<TParams>(EventType<TParams> eventType, TParams eventParams)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
||||
<td><em>eventType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TParams</span></td>
|
||||
<td><em>eventParams</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1_SendResult__0_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%601.SendResult(%600)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/RequestContext.cs/#L25">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1_SendResult__0_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext`1.SendResult(`0)">SendResult(TResult)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public virtual Task SendResult(TResult resultDetails)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">TResult</span></td>
|
||||
<td><em>resultDetails</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_1.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%601%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/RequestContext.cs/#L12" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,220 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Interface IMessageSerializer
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Interface IMessageSerializer
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Serializers_IMessageSerializer.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer%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/Hosting/Protocol/Serializers/IMessageSerializer.cs/#L14" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer">Interface IMessageSerializer
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Defines a common interface for message serializers.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface IMessageSerializer</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_DeserializeMessage_Newtonsoft_Json_Linq_JObject_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.DeserializeMessage(Newtonsoft.Json.Linq.JObject)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Serializers/IMessageSerializer.cs/#L28">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_DeserializeMessage_Newtonsoft_Json_Linq_JObject_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.DeserializeMessage(Newtonsoft.Json.Linq.JObject)">DeserializeMessage(JObject)</h4>
|
||||
<div class="markdown level1 summary"><p>Deserializes a JObject to a Messsage.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">Message DeserializeMessage(JObject messageJson)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JObject</span></td>
|
||||
<td><em>messageJson</em></td>
|
||||
<td><p>The JObject containing the JSON representation of the message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><p>The Message that was represented by the JObject.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_SerializeMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.SerializeMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Serializers/IMessageSerializer.cs/#L21">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_SerializeMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.SerializeMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message)">SerializeMessage(Message)</h4>
|
||||
<div class="markdown level1 summary"><p>Serializes a Message to a JObject.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">JObject SerializeMessage(Message message)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><em>message</em></td>
|
||||
<td><p>The message to be serialized.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JObject</span></td>
|
||||
<td><p>A JObject which contains the JSON representation of the message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Serializers/IMessageSerializer.cs/#L14" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,220 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class JsonRpcMessageSerializer
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class JsonRpcMessageSerializer
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Serializers_JsonRpcMessageSerializer.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.JsonRpcMessageSerializer%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/Hosting/Protocol/Serializers/JsonRpcMessageSerializer.cs/#L15" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_JsonRpcMessageSerializer" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.JsonRpcMessageSerializer">Class JsonRpcMessageSerializer
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Serializes messages in the JSON RPC format. Used primarily
|
||||
for language servers.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">JsonRpcMessageSerializer</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_JsonRpcMessageSerializer_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class JsonRpcMessageSerializer : IMessageSerializer</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_JsonRpcMessageSerializer_DeserializeMessage_Newtonsoft_Json_Linq_JObject_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.JsonRpcMessageSerializer.DeserializeMessage(Newtonsoft.Json.Linq.JObject)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Serializers/JsonRpcMessageSerializer.cs/#L53">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_JsonRpcMessageSerializer_DeserializeMessage_Newtonsoft_Json_Linq_JObject_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.JsonRpcMessageSerializer.DeserializeMessage(Newtonsoft.Json.Linq.JObject)">DeserializeMessage(JObject)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Message DeserializeMessage(JObject messageJson)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JObject</span></td>
|
||||
<td><em>messageJson</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_JsonRpcMessageSerializer_SerializeMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.JsonRpcMessageSerializer.SerializeMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Serializers/JsonRpcMessageSerializer.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_JsonRpcMessageSerializer_SerializeMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.JsonRpcMessageSerializer.SerializeMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message)">SerializeMessage(Message)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public JObject SerializeMessage(Message message)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><em>message</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JObject</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_JsonRpcMessageSerializer.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.JsonRpcMessageSerializer%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Serializers/JsonRpcMessageSerializer.cs/#L15" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,219 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class V8MessageSerializer
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class V8MessageSerializer
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Serializers_V8MessageSerializer.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.V8MessageSerializer%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/Hosting/Protocol/Serializers/V8MessageSerializer.cs/#L15" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_V8MessageSerializer" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.V8MessageSerializer">Class V8MessageSerializer
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Serializes messages in the V8 format. Used primarily for debug adapters.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">V8MessageSerializer</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_V8MessageSerializer_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class V8MessageSerializer : IMessageSerializer</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_V8MessageSerializer_DeserializeMessage_Newtonsoft_Json_Linq_JObject_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.V8MessageSerializer.DeserializeMessage(Newtonsoft.Json.Linq.JObject)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Serializers/V8MessageSerializer.cs/#L57">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_V8MessageSerializer_DeserializeMessage_Newtonsoft_Json_Linq_JObject_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.V8MessageSerializer.DeserializeMessage(Newtonsoft.Json.Linq.JObject)">DeserializeMessage(JObject)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Message DeserializeMessage(JObject messageJson)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JObject</span></td>
|
||||
<td><em>messageJson</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_V8MessageSerializer_SerializeMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.V8MessageSerializer.SerializeMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Serializers/V8MessageSerializer.cs/#L17">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_V8MessageSerializer_SerializeMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.V8MessageSerializer.SerializeMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message)">SerializeMessage(Message)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public JObject SerializeMessage(Message message)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a></td>
|
||||
<td><em>message</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Newtonsoft.Json.Linq.JObject</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_V8MessageSerializer.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.V8MessageSerializer%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Serializers/V8MessageSerializer.cs/#L15" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,124 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol_Serializers.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers">Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.JsonRpcMessageSerializer.html">JsonRpcMessageSerializer</a></h4>
|
||||
<section><p>Serializes messages in the JSON RPC format. Used primarily
|
||||
for language servers.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.V8MessageSerializer.html">V8MessageSerializer</a></h4>
|
||||
<section><p>Serializes messages in the V8 format. Used primarily for debug adapters.</p>
|
||||
</section>
|
||||
<h3 id="interfaces">Interfaces
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.html">IMessageSerializer</a></h4>
|
||||
<section><p>Defines a common interface for message serializers.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,146 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_Protocol.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol">Namespace Microsoft.SqlTools.ServiceLayer.Hosting.Protocol
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Constants.html">Constants</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a></h4>
|
||||
<section><p>Provides context for a received event so that handlers
|
||||
can write events back to the channel.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.html">MessageDispatcher</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageParseException.html">MessageParseException</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageReader.html">MessageReader</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.html">MessageWriter</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html">ProtocolEndpoint</a></h4>
|
||||
<section><p>Provides behavior for a client or server endpoint that
|
||||
communicates using the specified protocol.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><TResult></h4>
|
||||
<section></section>
|
||||
<h3 id="interfaces">Interfaces
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IMessageSender.html">IMessageSender</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.html">IProtocolEndpoint</a></h4>
|
||||
<section><p>A ProtocolEndpoint is used for inter-process communication. Services can register to
|
||||
respond to requests and events, send their own requests, and listen for notifications
|
||||
sent by the other side of the endpoint</p>
|
||||
</section>
|
||||
<h3 id="enums">Enums
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType.html">MessageProtocolType</a></h4>
|
||||
<section><p>Defines the possible message protocol types.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,120 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Delegate ServiceHost.InitializeCallback
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Delegate ServiceHost.InitializeCallback
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_ServiceHost_InitializeCallback.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.InitializeCallback%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/Hosting/ServiceHost.cs/#L84" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_InitializeCallback" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.InitializeCallback">Delegate ServiceHost.InitializeCallback
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Delegate definition for the host initialization event</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_InitializeCallback_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public delegate Task InitializeCallback(InitializeRequest startupParams, RequestContext<InitializeResult> requestContext);</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_InitializeCallback.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.InitializeCallback%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L84" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,120 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Delegate ServiceHost.ShutdownCallback
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Delegate ServiceHost.ShutdownCallback
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_ServiceHost_ShutdownCallback.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.ShutdownCallback%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/Hosting/ServiceHost.cs/#L77" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_ShutdownCallback" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.ShutdownCallback">Delegate ServiceHost.ShutdownCallback
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Delegate definition for the host shutdown event</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_ShutdownCallback_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public delegate Task ShutdownCallback(object shutdownParams, RequestContext<object> shutdownRequestContext);</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_ShutdownCallback.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.ShutdownCallback%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L77" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,244 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ServiceHost
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ServiceHost
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_ServiceHost.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost%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/Hosting/ServiceHost.cs/#L23" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost">Class ServiceHost
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>SQL Tools VS Code Language Server request handler. Provides the entire JSON RPC
|
||||
implementation for sending/receiving JSON requests and dispatching the requests to
|
||||
handlers that are registered prior to startup.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html">ProtocolEndpoint</a></div>
|
||||
<div class="level2"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase.html">ServiceHostBase</a></div>
|
||||
<div class="level3"><span class="xref">ServiceHost</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class ServiceHost : ServiceHostBase, IProtocolEndpoint, IMessageSender</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_Instance.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.Instance%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L41">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_Instance" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.Instance">Instance</h4>
|
||||
<div class="markdown level1 summary"><p>Current instance of the ServiceHost</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static ServiceHost Instance { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.html">ServiceHost</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_Initialize.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.Initialize%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L60">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_Initialize" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.Initialize">Initialize()</h4>
|
||||
<div class="markdown level1 summary"><p>Provide initialization that must occur after the service host is started</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Initialize()</code></pre>
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_RegisterInitializeTask_Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_InitializeCallback_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.RegisterInitializeTask(Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.InitializeCallback)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L109">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_RegisterInitializeTask_Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_InitializeCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.RegisterInitializeTask(Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.InitializeCallback)">RegisterInitializeTask(ServiceHost.InitializeCallback)</h4>
|
||||
<div class="markdown level1 summary"><p>Add a new method to be called when the initialize request is submitted</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void RegisterInitializeTask(ServiceHost.InitializeCallback callback)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.InitializeCallback.html">ServiceHost.InitializeCallback</a></td>
|
||||
<td><em>callback</em></td>
|
||||
<td><p>Callback to perform when an initialize request is submitted</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_RegisterShutdownTask_Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_ShutdownCallback_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.RegisterShutdownTask(Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.ShutdownCallback)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L100">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_RegisterShutdownTask_Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_ShutdownCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.RegisterShutdownTask(Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.ShutdownCallback)">RegisterShutdownTask(ServiceHost.ShutdownCallback)</h4>
|
||||
<div class="markdown level1 summary"><p>Adds a new callback to be called when the shutdown request is submitted</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void RegisterShutdownTask(ServiceHost.ShutdownCallback callback)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.ShutdownCallback.html">ServiceHost.ShutdownCallback</a></td>
|
||||
<td><em>callback</em></td>
|
||||
<td><p>Callback to perform when a shutdown request is submitted</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L23" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,189 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ServiceHostBase
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ServiceHostBase
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting_ServiceHostBase.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase%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/Hosting/ServiceHostBase.cs/#L13" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHostBase" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase">Class ServiceHostBase
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html">ProtocolEndpoint</a></div>
|
||||
<div class="level2"><span class="xref">ServiceHostBase</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHostBase_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public abstract class ServiceHostBase : ProtocolEndpoint, IProtocolEndpoint, IMessageSender</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHostBase__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase.%23ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHostBase.cs/#L18">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHostBase__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase.#ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase)">ServiceHostBase(ChannelBase)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected ServiceHostBase(ChannelBase serverChannel)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.html">ChannelBase</a></td>
|
||||
<td><em>serverChannel</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHostBase_OnStart.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase.OnStart%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHostBase.cs/#L23">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHostBase_OnStart" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase.OnStart">OnStart()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override Task OnStart()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHostBase.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHostBase.cs/#L13" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,127 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.Hosting
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.Hosting
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Hosting.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting">Namespace Microsoft.SqlTools.ServiceLayer.Hosting
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.html">ServiceHost</a></h4>
|
||||
<section><p>SQL Tools VS Code Language Server request handler. Provides the entire JSON RPC
|
||||
implementation for sending/receiving JSON requests and dispatching the requests to
|
||||
handlers that are registered prior to startup.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase.html">ServiceHostBase</a></h4>
|
||||
<section></section>
|
||||
<h3 id="delegates">Delegates
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.InitializeCallback.html">ServiceHost.InitializeCallback</a></h4>
|
||||
<section><p>Delegate definition for the host initialization event</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.ShutdownCallback.html">ServiceHost.ShutdownCallback</a></h4>
|
||||
<section><p>Delegate definition for the host shutdown event</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,265 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class InteractionMetrics<T>
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class InteractionMetrics<T>
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_InteractionMetrics_1.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.InteractionMetrics%601%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/InteractionMetrics.cs/#L18" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1" data-uid="Microsoft.SqlTools.ServiceLayer.InteractionMetrics`1">Class InteractionMetrics<T>
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>A class to calculate the value for the metrics using the given bucket</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">InteractionMetrics<T></span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class InteractionMetrics<T></code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1__ctor_System_Int32___.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.InteractionMetrics%601.%23ctor(System.Int32%5B%5D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/InteractionMetrics.cs/#L23">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1__ctor_System_Int32___" data-uid="Microsoft.SqlTools.ServiceLayer.InteractionMetrics`1.#ctor(System.Int32[])">InteractionMetrics(Int32[])</h4>
|
||||
<div class="markdown level1 summary"><p>Creates new instance given a bucket of metrics</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public InteractionMetrics(int[] metrics)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span>[]</td>
|
||||
<td><em>metrics</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1_Metrics.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.InteractionMetrics%601.Metrics%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/InteractionMetrics.cs/#L46">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1_Metrics" data-uid="Microsoft.SqlTools.ServiceLayer.InteractionMetrics`1.Metrics">Metrics</h4>
|
||||
<div class="markdown level1 summary"><p>The metrics bucket</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int[] Metrics { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span>[]</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1_Quantile.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.InteractionMetrics%601.Quantile%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/InteractionMetrics.cs/#L89">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1_Quantile" data-uid="Microsoft.SqlTools.ServiceLayer.InteractionMetrics`1.Quantile">Quantile</h4>
|
||||
<div class="markdown level1 summary"><p>Returns the quantile</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Dictionary<string, T> Quantile { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.Dictionary</span><<span class="xref">System.String</span>, T></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1_UpdateMetrics_System_Double__0_System_Func_System_String__0__0__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.InteractionMetrics%601.UpdateMetrics(System.Double%2C%600%2CSystem.Func%7BSystem.String%2C%600%2C%600%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/InteractionMetrics.cs/#L71">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1_UpdateMetrics_System_Double__0_System_Func_System_String__0__0__" data-uid="Microsoft.SqlTools.ServiceLayer.InteractionMetrics`1.UpdateMetrics(System.Double,`0,System.Func{System.String,`0,`0})">UpdateMetrics(Double, T, Func<String, T, T>)</h4>
|
||||
<div class="markdown level1 summary"><p>Update metric value given new number</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void UpdateMetrics(double duration, T newValue, Func<string, T, T> updateValueFactory)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Double</span></td>
|
||||
<td><em>duration</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">T</span></td>
|
||||
<td><em>newValue</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><<span class="xref">System.String</span>, T, T></td>
|
||||
<td><em>updateValueFactory</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_InteractionMetrics_1.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.InteractionMetrics%601%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/InteractionMetrics.cs/#L18" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,126 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class AutoCompleteHelper
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class AutoCompleteHelper
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_AutoCompleteHelper.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.AutoCompleteHelper%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/AutoCompleteHelper.cs/#L27" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_AutoCompleteHelper" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.AutoCompleteHelper">Class AutoCompleteHelper
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Main class for Language Service functionality including anything that reqires knowledge of
|
||||
the language to perfom, such as definitions, intellisense, etc.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">AutoCompleteHelper</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_AutoCompleteHelper_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class AutoCompleteHelper</code></pre>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_AutoCompleteHelper.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.AutoCompleteHelper%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/AutoCompleteHelper.cs/#L27" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,353 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class BindingQueue<T>
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class BindingQueue<T>
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_BindingQueue_1.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue%601%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/BindingQueue.cs/#L17" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue`1">Class BindingQueue<T>
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Main class for the Binding Queue</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">BindingQueue<T></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_BindingQueue_1_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class BindingQueue<T>
|
||||
where T : IBindingContext, new ()</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1__ctor.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue%601.%23ctor%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/BindingQueue.cs/#L40">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue`1.#ctor">BindingQueue()</h4>
|
||||
<div class="markdown level1 summary"><p>Constructor for a binding queue instance</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public BindingQueue()</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1_BindingContextExists_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue%601.BindingContextExists(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/BindingQueue.cs/#L118">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1_BindingContextExists_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue`1.BindingContextExists(System.String)">BindingContextExists(String)</h4>
|
||||
<div class="markdown level1 summary"><p>Checks if a binding context already exists for the provided context key</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected bool BindingContextExists(string key)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>key</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1_GetOrCreateBindingContext_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue%601.GetOrCreateBindingContext(System.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/BindingQueue.cs/#L96">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1_GetOrCreateBindingContext_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue`1.GetOrCreateBindingContext(System.String)">GetOrCreateBindingContext(String)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or creates a binding context for the provided context key</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected IBindingContext GetOrCreateBindingContext(string key)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>key</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.IBindingContext.html">IBindingContext</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1_QueueBindingOperation_System_String_System_Func_Microsoft_SqlTools_ServiceLayer_LanguageServices_IBindingContext_System_Threading_CancellationToken_System_Object__System_Func_Microsoft_SqlTools_ServiceLayer_LanguageServices_IBindingContext_System_Object__System_Nullable_System_Int32__System_Nullable_System_Int32__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue%601.QueueBindingOperation(System.String%2CSystem.Func%7BMicrosoft.SqlTools.ServiceLayer.LanguageServices.IBindingContext%2CSystem.Threading.CancellationToken%2CSystem.Object%7D%2CSystem.Func%7BMicrosoft.SqlTools.ServiceLayer.LanguageServices.IBindingContext%2CSystem.Object%7D%2CSystem.Nullable%7BSystem.Int32%7D%2CSystem.Nullable%7BSystem.Int32%7D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/BindingQueue.cs/#L60">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1_QueueBindingOperation_System_String_System_Func_Microsoft_SqlTools_ServiceLayer_LanguageServices_IBindingContext_System_Threading_CancellationToken_System_Object__System_Func_Microsoft_SqlTools_ServiceLayer_LanguageServices_IBindingContext_System_Object__System_Nullable_System_Int32__System_Nullable_System_Int32__" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue`1.QueueBindingOperation(System.String,System.Func{Microsoft.SqlTools.ServiceLayer.LanguageServices.IBindingContext,System.Threading.CancellationToken,System.Object},System.Func{Microsoft.SqlTools.ServiceLayer.LanguageServices.IBindingContext,System.Object},System.Nullable{System.Int32},System.Nullable{System.Int32})">QueueBindingOperation(String, Func<IBindingContext, CancellationToken, Object>, Func<IBindingContext, Object>, Nullable<Int32>, Nullable<Int32>)</h4>
|
||||
<div class="markdown level1 summary"><p>Queue a binding request item</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public virtual QueueItem QueueBindingOperation(string key, Func<IBindingContext, CancellationToken, object> bindOperation, Func<IBindingContext, object> timeoutOperation = null, int ? bindingTimeout = null, int ? waitForLockTimeout = null)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>key</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.IBindingContext.html">IBindingContext</a>, <span class="xref">System.Threading.CancellationToken</span>, <span class="xref">System.Object</span>></td>
|
||||
<td><em>bindOperation</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Func</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.IBindingContext.html">IBindingContext</a>, <span class="xref">System.Object</span>></td>
|
||||
<td><em>timeoutOperation</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td><em>bindingTimeout</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td><em>waitForLockTimeout</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.QueueItem.html">QueueItem</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1_StopQueueProcessor_System_Int32_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue%601.StopQueueProcessor(System.Int32)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/BindingQueue.cs/#L51">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1_StopQueueProcessor_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue`1.StopQueueProcessor(System.Int32)">StopQueueProcessor(Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Stops the binding queue by sending cancellation request</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool StopQueueProcessor(int timeout)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>timeout</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_BindingQueue_1.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue%601%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/BindingQueue.cs/#L17" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,238 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class AutoCompletionResult
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class AutoCompletionResult
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Completion_AutoCompletionResult.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult%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/Completion/AutoCompletionResult.cs/#L16" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult">Class AutoCompletionResult
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Includes the objects created by auto completion service</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">AutoCompletionResult</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class AutoCompletionResult</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult__ctor.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult.%23ctor%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/AutoCompletionResult.cs/#L21">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult.#ctor">AutoCompletionResult()</h4>
|
||||
<div class="markdown level1 summary"><p>Creates new instance</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public AutoCompletionResult()</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult_CompletionItems.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult.CompletionItems%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/AutoCompletionResult.cs/#L52">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult_CompletionItems" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult.CompletionItems">CompletionItems</h4>
|
||||
<div class="markdown level1 summary"><p>Completion list</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CompletionItem[] CompletionItems { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.html">CompletionItem</a>[]</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult_Duration.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult.Duration%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/AutoCompletionResult.cs/#L41">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult_Duration" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult.Duration">Duration</h4>
|
||||
<div class="markdown level1 summary"><p>The number of milliseconds to process the result</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public double Duration { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Double</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult_CompleteResult_Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem___.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult.CompleteResult(Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem%5B%5D)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/AutoCompletionResult.cs/#L32">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult_CompleteResult_Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem___" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult.CompleteResult(Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem[])">CompleteResult(CompletionItem[])</h4>
|
||||
<div class="markdown level1 summary"><p>Completes the results to calculate the duration</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void CompleteResult(CompletionItem[] completionItems)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.html">CompletionItem</a>[]</td>
|
||||
<td><em>completionItems</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_AutoCompletionResult.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/AutoCompletionResult.cs/#L16" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,183 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Interface ISqlParserWrapper
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Interface ISqlParserWrapper
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Completion_ISqlParserWrapper.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.ISqlParserWrapper%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/Completion/SqlParserWrapper.cs/#L16" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_ISqlParserWrapper" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.ISqlParserWrapper">Interface ISqlParserWrapper
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>SqlParserWrapper interface</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_ISqlParserWrapper_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface ISqlParserWrapper</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_ISqlParserWrapper_FindCompletions_Microsoft_SqlServer_Management_SqlParser_Parser_ParseResult_System_Int32_System_Int32_Microsoft_SqlServer_Management_SqlParser_MetadataProvider_IMetadataDisplayInfoProvider_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.ISqlParserWrapper.FindCompletions(Microsoft.SqlServer.Management.SqlParser.Parser.ParseResult%2CSystem.Int32%2CSystem.Int32%2CMicrosoft.SqlServer.Management.SqlParser.MetadataProvider.IMetadataDisplayInfoProvider)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlParserWrapper.cs/#L18">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_ISqlParserWrapper_FindCompletions_Microsoft_SqlServer_Management_SqlParser_Parser_ParseResult_System_Int32_System_Int32_Microsoft_SqlServer_Management_SqlParser_MetadataProvider_IMetadataDisplayInfoProvider_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.ISqlParserWrapper.FindCompletions(Microsoft.SqlServer.Management.SqlParser.Parser.ParseResult,System.Int32,System.Int32,Microsoft.SqlServer.Management.SqlParser.MetadataProvider.IMetadataDisplayInfoProvider)">FindCompletions(ParseResult, Int32, Int32, IMetadataDisplayInfoProvider)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">IEnumerable<Declaration> FindCompletions(ParseResult parseResult, int line, int col, IMetadataDisplayInfoProvider displayInfoProvider)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Parser.ParseResult</span></td>
|
||||
<td><em>parseResult</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>line</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>col</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.MetadataProvider.IMetadataDisplayInfoProvider</span></td>
|
||||
<td><em>displayInfoProvider</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">Microsoft.SqlServer.Management.SqlParser.Intellisense.Declaration</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_ISqlParserWrapper.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.ISqlParserWrapper%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlParserWrapper.cs/#L16" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,554 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class SqlCompletionItem
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class SqlCompletionItem
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Completion_SqlCompletionItem.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem%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/Completion/SqlCompletionItem.cs/#L18" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem">Class SqlCompletionItem
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Creates a completion item from SQL parser declaration item</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">SqlCompletionItem</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SqlCompletionItem</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem__ctor_Microsoft_SqlServer_Management_SqlParser_Intellisense_Declaration_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.%23ctor(Microsoft.SqlServer.Management.SqlParser.Intellisense.Declaration%2CSystem.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L25">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem__ctor_Microsoft_SqlServer_Management_SqlParser_Intellisense_Declaration_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.#ctor(Microsoft.SqlServer.Management.SqlParser.Intellisense.Declaration,System.String)">SqlCompletionItem(Declaration, String)</h4>
|
||||
<div class="markdown level1 summary"><p>Create new instance given the SQL parser declaration</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SqlCompletionItem(Declaration declaration, string tokenText)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Intellisense.Declaration</span></td>
|
||||
<td><em>declaration</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>tokenText</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem__ctor_System_String_Microsoft_SqlServer_Management_SqlParser_Intellisense_DeclarationType_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.%23ctor(System.String%2CMicrosoft.SqlServer.Management.SqlParser.Intellisense.DeclarationType%2CSystem.String)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L33">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem__ctor_System_String_Microsoft_SqlServer_Management_SqlParser_Intellisense_DeclarationType_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.#ctor(System.String,Microsoft.SqlServer.Management.SqlParser.Intellisense.DeclarationType,System.String)">SqlCompletionItem(String, DeclarationType, String)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates new instance given declaration title and type</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SqlCompletionItem(string declarationTitle, DeclarationType declarationType, string tokenText)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>declarationTitle</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Intellisense.DeclarationType</span></td>
|
||||
<td><em>declarationType</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>tokenText</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_DeclarationTitle.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.DeclarationTitle%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L91">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_DeclarationTitle" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.DeclarationTitle">DeclarationTitle</h4>
|
||||
<div class="markdown level1 summary"><p>Declaration Title</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string DeclarationTitle { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_DeclarationType.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.DeclarationType%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L101">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_DeclarationType" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.DeclarationType">DeclarationType</h4>
|
||||
<div class="markdown level1 summary"><p>SQL declaration type</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DeclarationType DeclarationType { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Intellisense.DeclarationType</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Detail.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Detail%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L121">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Detail" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Detail">Detail</h4>
|
||||
<div class="markdown level1 summary"><p>Completion item detail</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Detail { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_InsertText.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.InsertText%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L116">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_InsertText" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.InsertText">InsertText</h4>
|
||||
<div class="markdown level1 summary"><p>Completion insert text</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string InsertText { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Kind.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Kind%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L111">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Kind" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Kind">Kind</h4>
|
||||
<div class="markdown level1 summary"><p>Completion item kind</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CompletionItemKind Kind { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItemKind.html">CompletionItemKind</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Label.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Label%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L106">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Label" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Label">Label</h4>
|
||||
<div class="markdown level1 summary"><p>Completion item label</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Label { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_TokenText.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.TokenText%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L96">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_TokenText" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.TokenText">TokenText</h4>
|
||||
<div class="markdown level1 summary"><p>Token text from the editor</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string TokenText { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_CreateCompletionItem_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.CreateCompletionItem(System.Int32%2CSystem.Int32%2CSystem.Int32)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L126">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_CreateCompletionItem_System_Int32_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.CreateCompletionItem(System.Int32,System.Int32,System.Int32)">CreateCompletionItem(Int32, Int32, Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates a completion item given the editor info</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CompletionItem CreateCompletionItem(int row, int startColumn, int endColumn)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>row</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>startColumn</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>endColumn</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.html">CompletionItem</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_CreateCompletionItem_System_String_System_String_System_String_Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItemKind_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.CreateCompletionItem(System.String%2CSystem.String%2CSystem.String%2CMicrosoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItemKind%2CSystem.Int32%2CSystem.Int32%2CSystem.Int32)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L137">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_CreateCompletionItem_System_String_System_String_System_String_Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItemKind_System_Int32_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.CreateCompletionItem(System.String,System.String,System.String,Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItemKind,System.Int32,System.Int32,System.Int32)">CreateCompletionItem(String, String, String, CompletionItemKind, Int32, Int32, Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates a completion item</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static CompletionItem CreateCompletionItem(string label, string detail, string insertText, CompletionItemKind kind, int row, int startColumn, int endColumn)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>label</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>detail</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><em>insertText</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItemKind.html">CompletionItemKind</a></td>
|
||||
<td><em>kind</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>row</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>startColumn</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>endColumn</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.html">CompletionItem</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L18" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,189 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class SqlParserWrapper
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class SqlParserWrapper
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Completion_SqlParserWrapper.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlParserWrapper%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/Completion/SqlParserWrapper.cs/#L24" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlParserWrapper" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlParserWrapper">Class SqlParserWrapper
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>A wrapper class around SQL parser methods to make the operations testable</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">SqlParserWrapper</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlParserWrapper_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SqlParserWrapper : ISqlParserWrapper</code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlParserWrapper_FindCompletions_Microsoft_SqlServer_Management_SqlParser_Parser_ParseResult_System_Int32_System_Int32_Microsoft_SqlServer_Management_SqlParser_MetadataProvider_IMetadataDisplayInfoProvider_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlParserWrapper.FindCompletions(Microsoft.SqlServer.Management.SqlParser.Parser.ParseResult%2CSystem.Int32%2CSystem.Int32%2CMicrosoft.SqlServer.Management.SqlParser.MetadataProvider.IMetadataDisplayInfoProvider)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlParserWrapper.cs/#L29">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlParserWrapper_FindCompletions_Microsoft_SqlServer_Management_SqlParser_Parser_ParseResult_System_Int32_System_Int32_Microsoft_SqlServer_Management_SqlParser_MetadataProvider_IMetadataDisplayInfoProvider_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlParserWrapper.FindCompletions(Microsoft.SqlServer.Management.SqlParser.Parser.ParseResult,System.Int32,System.Int32,Microsoft.SqlServer.Management.SqlParser.MetadataProvider.IMetadataDisplayInfoProvider)">FindCompletions(ParseResult, Int32, Int32, IMetadataDisplayInfoProvider)</h4>
|
||||
<div class="markdown level1 summary"><p>Creates completion list given SQL script info</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IEnumerable<Declaration> FindCompletions(ParseResult parseResult, int line, int col, IMetadataDisplayInfoProvider displayInfoProvider)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Parser.ParseResult</span></td>
|
||||
<td><em>parseResult</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>line</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><em>col</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.MetadataProvider.IMetadataDisplayInfoProvider</span></td>
|
||||
<td><em>displayInfoProvider</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">Microsoft.SqlServer.Management.SqlParser.Intellisense.Declaration</span>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlParserWrapper.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlParserWrapper%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlParserWrapper.cs/#L24" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,126 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Namespace Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Completion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion%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>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion">Namespace Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
<h3 id="classes">Classes
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.AutoCompletionResult.html">AutoCompletionResult</a></h4>
|
||||
<section><p>Includes the objects created by auto completion service</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.html">SqlCompletionItem</a></h4>
|
||||
<section><p>Creates a completion item from SQL parser declaration item</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlParserWrapper.html">SqlParserWrapper</a></h4>
|
||||
<section><p>A wrapper class around SQL parser methods to make the operations testable</p>
|
||||
</section>
|
||||
<h3 id="interfaces">Interfaces
|
||||
</h3>
|
||||
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.ISqlParserWrapper.html">ISqlParserWrapper</a></h4>
|
||||
<section><p>SqlParserWrapper interface</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,504 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectedBindingContext
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectedBindingContext
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_ConnectedBindingContext.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext%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/ConnectedBindingContext.cs/#L20" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext">Class ConnectedBindingContext
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Class for the binding context for connected sessions</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">ConnectedBindingContext</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_ConnectedBindingContext_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectedBindingContext : IBindingContext</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext__ctor.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.%23ctor%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L31">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.#ctor">ConnectedBindingContext()</h4>
|
||||
<div class="markdown level1 summary"><p>Connected binding context constructor</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConnectedBindingContext()</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_Binder.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.Binder%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L74">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_Binder" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.Binder">Binder</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the binder</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IBinder Binder { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Binder.IBinder</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_BindingLock.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.BindingLock%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L79">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_BindingLock" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.BindingLock">BindingLock</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the binding lock object</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ManualResetEvent BindingLock { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.ManualResetEvent</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_BindingTimeout.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.BindingTimeout%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L90">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_BindingTimeout" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.BindingTimeout">BindingTimeout</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the binding operation timeout in milliseconds</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int BindingTimeout { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_DatabaseCompatibilityLevel.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.DatabaseCompatibilityLevel%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L134">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_DatabaseCompatibilityLevel" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.DatabaseCompatibilityLevel">DatabaseCompatibilityLevel</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the current DatabaseCompatibilityLevel</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DatabaseCompatibilityLevel DatabaseCompatibilityLevel { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Common.DatabaseCompatibilityLevel</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_DatabaseEngineType.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.DatabaseEngineType%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L108">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_DatabaseEngineType" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.DatabaseEngineType">DatabaseEngineType</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the current DataEngineType</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DatabaseEngineType DatabaseEngineType { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.Common.DatabaseEngineType</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_IsConnected.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.IsConnected%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L41">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_IsConnected" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.IsConnected">IsConnected</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a flag indicating if the binder is connected</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsConnected { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_MetadataDisplayInfoProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.MetadataDisplayInfoProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L64">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_MetadataDisplayInfoProvider" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.MetadataDisplayInfoProvider">MetadataDisplayInfoProvider</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the metadata display info provider</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MetadataDisplayInfoProvider MetadataDisplayInfoProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.MetadataProvider.MetadataDisplayInfoProvider</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_ParseOptions.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.ParseOptions%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L147">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_ParseOptions" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.ParseOptions">ParseOptions</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the current ParseOptions</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ParseOptions ParseOptions { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Parser.ParseOptions</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_ServerConnection.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.ServerConnection%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L46">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_ServerConnection" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.ServerConnection">ServerConnection</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the binding server connection</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ServerConnection ServerConnection { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.Common.ServerConnection</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_ServerVersion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.ServerVersion%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L95">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_ServerVersion" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.ServerVersion">ServerVersion</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the Language Service ServerVersion</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ServerVersion ServerVersion { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.Common.ServerVersion</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_SmoMetadataProvider.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.SmoMetadataProvider%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L69">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_SmoMetadataProvider" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.SmoMetadataProvider">SmoMetadataProvider</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the SMO metadata provider</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SmoMetadataProvider SmoMetadataProvider { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SmoMetadataProvider.SmoMetadataProvider</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_TransactSqlVersion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.TransactSqlVersion%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L121">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext_TransactSqlVersion" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.TransactSqlVersion">TransactSqlVersion</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the current connections TransactSqlVersion</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public TransactSqlVersion TransactSqlVersion { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Common.TransactSqlVersion</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingContext.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingContext.cs/#L20" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,175 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class ConnectedBindingQueue
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ConnectedBindingQueue
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_ConnectedBindingQueue.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingQueue%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/ConnectedBindingQueue.cs/#L22" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingQueue" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingQueue">Class ConnectedBindingQueue
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>ConnectedBindingQueue class for processing online binding requests</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.BindingQueue-1.html">BindingQueue</a><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingContext.html">ConnectedBindingContext</a>></div>
|
||||
<div class="level2"><span class="xref">ConnectedBindingQueue</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_ConnectedBindingQueue_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConnectedBindingQueue : BindingQueue<ConnectedBindingContext></code></pre>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingQueue_AddConnectionContext_Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingQueue.AddConnectionContext(Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo)%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingQueue.cs/#L55">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingQueue_AddConnectionContext_Microsoft_SqlTools_ServiceLayer_Connection_ConnectionInfo_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingQueue.AddConnectionContext(Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo)">AddConnectionContext(ConnectionInfo)</h4>
|
||||
<div class="markdown level1 summary"><p>Use a ConnectionInfo item to create a connected binding context</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public virtual string AddConnectionContext(ConnectionInfo connInfo)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.html">ConnectionInfo</a></td>
|
||||
<td><em>connInfo</em></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_ConnectedBindingQueue.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.ConnectedBindingQueue%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/ConnectedBindingQueue.cs/#L22" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,392 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class CompletionItem
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class CompletionItem
|
||||
">
|
||||
|
||||
<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/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">
|
||||
<!--
|
||||
<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 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">
|
||||
<ul class="breadcrumb">
|
||||
<li></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||||
<div class="sidetoggle collapse" id="sidetoggle">
|
||||
<div id="sidetoc"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="article row grid-right">
|
||||
<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_Contracts_CompletionItem.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem%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/Contracts/Completion.cs/#L56" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem">Class CompletionItem
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">CompletionItem</span></div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CompletionItem</code></pre>
|
||||
</div>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Data.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Data%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L84">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Data" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Data">Data</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets a custom data field that allows the server to mark
|
||||
each completion item with an identifier that will help correlate
|
||||
the item to the previous completion request during a completion
|
||||
resolve request.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public object Data { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Object</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Detail.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Detail%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L63">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Detail" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Detail">Detail</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Detail { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Documentation.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Documentation%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L68">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Documentation" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Documentation">Documentation</h4>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the documentation string for the completion item.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Documentation { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_FilterText.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.FilterText%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L72">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_FilterText" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.FilterText">FilterText</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string FilterText { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_InsertText.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.InsertText%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L74">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_InsertText" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.InsertText">InsertText</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string InsertText { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Kind.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Kind%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L61">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Kind" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Kind">Kind</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CompletionItemKind? Kind { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItemKind.html">CompletionItemKind</a>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Label.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Label%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L59">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Label" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Label">Label</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Label { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_SortText.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.SortText%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L70">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_SortText" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.SortText">SortText</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string SortText { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_TextEdit.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.TextEdit%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">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L76">View Source</a>
|
||||
</span>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_TextEdit" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.TextEdit">TextEdit</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public TextEdit TextEdit { get; set; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue"></h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.TextEdit.html">TextEdit</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
<div class="hidden-sm col-md-2" role="complementary">
|
||||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem%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="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L56" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||||
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="inner-footer">
|
||||
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
||||
<script type="text/javascript" src="../styles/docfx.js"></script>
|
||||
<script type="text/javascript" src="../styles/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user