mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-14 09:59:48 -05:00
* Initial commit for GitHub IO pages * Add initial doxfx content * Update manifest.json * Update manifest.json * Set theme jekyll-theme-cayman * Set theme jekyll-theme-slate * Set theme jekyll-theme-minimal * Set theme jekyll-theme-tactile * Clear out theme setting * Remove API docs * Revert "Adding Milliseconds to DateTime fields (#173)" (#197) This reverts commit431dfa4156. * ported new BatchParser * added BatchParser tests * fixing merge conflicts * fix build issues * cleaned code and addressed comments from code review * addressed code review and made BatchParser logic more efficient * fixed batch parser tests * changed class name to fix build issues * fixed merge conflicts * added path for lab mode baseline tests * changed env path for lab mode * added env variable to appveyor * testing env variable for appveyor * fixed lab build * debug appveyor build * testing changes for appveyor * changed trace env path * debugging appveyor build * changed baseline env path * debugging * debugging * debugging * switched on trace flag * debugging * debugging * changed build config * changed baseline files * checking baseline output * changed baseline files * debug baseline tests * debugging baseline * debugging * debugging * debug * debugging * testing baseline format * debug * debug * debug * debug * debug * newline debug * changed baseline file * debug * test * try new way to read * added execution engine tests * change test * testing file encoding * moved execution engine tests to integration * try compare without spaces * removed no op test * added env variable for travis * put batch parser tests to integration too * put batch parser in integration * try new baseline string match * compare baseline test logic changed * changed baseline logic as well as cleaned tests * fix build for travis CI * fix travis CI issues * fixed highlighting bugs on vscode * code review changes * ported new BatchParser * added BatchParser tests * Initial commit for GitHub IO pages * Add initial doxfx content * Update manifest.json * Update manifest.json * Set theme jekyll-theme-cayman * Set theme jekyll-theme-slate * Set theme jekyll-theme-minimal * Set theme jekyll-theme-tactile * Clear out theme setting * Remove API docs * Revert "Adding Milliseconds to DateTime fields (#173)" (#197) This reverts commit431dfa4156. * fixing merge conflicts * fix build issues * cleaned code and addressed comments from code review * addressed code review and made BatchParser logic more efficient * fixed batch parser tests * changed class name to fix build issues * fixed merge conflicts * added path for lab mode baseline tests changed env path for lab mode added env variable to appveyor testing env variable for appveyor fixed lab build debug appveyor build testing changes for appveyor changed trace env path debugging appveyor build changed baseline env path debugging debugging debugging switched on trace flag debugging debugging changed build config changed baseline files checking baseline output changed baseline files debug baseline tests debugging baseline debugging debugging debug debugging testing baseline format debug debug debug debug debug newline debug changed baseline file debug test try new way to read added execution engine tests change test testing file encoding moved execution engine tests to integration try compare without spaces removed no op test added env variable for travis * put batch parser tests to integration too * put batch parser in integration try new baseline string match * compare baseline test logic changed * changed baseline logic as well as cleaned tests * fix build for travis CI * fix travis CI issues * fixed highlighting bugs on vscode * code review changes * fixed filestream writer test * added localization string * added localization string * generated new string files again * code review changes
971 lines
67 KiB
HTML
971 lines
67 KiB
HTML
<!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
|
|
">
|
|
<meta name="generator" content="docfx 1.0.0.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<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_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>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.#ctor*"></a>
|
|
<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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.#ctor*"></a>
|
|
<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><span class="parametername">testFactory</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_ConnectionFactory_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.ConnectionFactory*"></a>
|
|
<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">Property Value</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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_Instance_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.Instance*"></a>
|
|
<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">Property Value</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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_BuildConnectionString_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.BuildConnectionString*"></a>
|
|
<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><span class="parametername">connectionDetails</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_CancelConnect_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.CancelConnect*"></a>
|
|
<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><span class="parametername">cancelParams</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_ChangeConnectionDatabaseContext_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.ChangeConnectionDatabaseContext*"></a>
|
|
<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><span class="parametername">ownerUri</span></td>
|
|
<td><p>URI of the owner of the connection</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">newDatabaseName</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_Connect_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.Connect*"></a>
|
|
<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><span class="parametername">connectionParams</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_Disconnect_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.Disconnect*"></a>
|
|
<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><span class="parametername">disconnectParams</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleCancelConnectRequest_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleCancelConnectRequest*"></a>
|
|
<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><span class="parametername">cancelParams</span></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><span class="parametername">requestContext</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleConnectRequest_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleConnectRequest*"></a>
|
|
<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><span class="parametername">connectParams</span></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><span class="parametername">requestContext</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleDidChangeConfigurationNotification_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleDidChangeConfigurationNotification*"></a>
|
|
<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><span class="parametername">newSettings</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.SqlContext.SqlToolsSettings.html">SqlToolsSettings</a></td>
|
|
<td><span class="parametername">oldSettings</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a></td>
|
|
<td><span class="parametername">eventContext</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleDisconnectRequest_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleDisconnectRequest*"></a>
|
|
<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><span class="parametername">disconnectParams</span></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><span class="parametername">requestContext</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_HandleListDatabasesRequest_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.HandleListDatabasesRequest*"></a>
|
|
<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><span class="parametername">listDatabasesParams</span></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><span class="parametername">requestContext</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_InitializeService_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.InitializeService*"></a>
|
|
<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><span class="parametername">serviceHost</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_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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_ListDatabases_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.ListDatabases*"></a>
|
|
<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><span class="parametername">listDatabasesParams</span></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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_RegisterOnConnectionTask_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.RegisterOnConnectionTask*"></a>
|
|
<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><span class="parametername">activity</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_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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_RegisterOnDisconnectTask_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.RegisterOnDisconnectTask*"></a>
|
|
<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><span class="parametername">activity</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_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>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Connection_ConnectionService_TryFindConnection_" data-uid="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService.TryFindConnection*"></a>
|
|
<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><span class="parametername">ownerUri</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Connection.ConnectionInfo.html">ConnectionInfo</a></td>
|
|
<td><span class="parametername">connectionInfo</span></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="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Copyright © 2015-2016 Microsoft<br>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</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>
|