ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-23 17:24:12 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
005e2957c2fbb809c6fe32cd5f55746eddcaea22
sqltoolsservice/docs/_site/api/Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.html
Karl Burtram edb3c4aa1f Add docs template
2016-12-15 17:06:28 -08:00

337 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class HostDetails
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class HostDetails
">
<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_SqlContext_HostDetails.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails%0Asummary%3A%20'*You%20can%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/SqlContext/HostDetails.cs/#L14" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_SqlContext_HostDetails" data-uid="Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails">Class HostDetails
</h1>
<div class="markdown level0 summary"><p>Contains details about the current host application (most
likely the editor which is using the host 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"><span class="xref">HostDetails</span></div>
</div>
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.SqlContext</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_SqlContext_HostDetails_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class HostDetails</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_SqlContext_HostDetails__ctor_System_String_System_String_System_Version_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.%23ctor(System.String%2CSystem.String%2CSystem.Version)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs/#L80">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_SqlContext_HostDetails__ctor_System_String_System_String_System_Version_" data-uid="Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.#ctor(System.String,System.String,System.Version)">HostDetails(String, String, Version)</h4>
<div class="markdown level1 summary"><p>Creates an instance of the HostDetails class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public HostDetails(string name = null, string profileId = null, Version version = 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>name</em></td>
<td><p>The display name for the host, typically in the form of
&quot;[Application Name] Host&quot;.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><em>profileId</em></td>
<td><p>The identifier of the SqlTools host to use for its profile path.
loaded. Used to resolve a profile path of the form &#39;X_profile.ps1&#39;
where &#39;X&#39; represents the value of hostProfileId. If null, a default
will be used.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Version</span></td>
<td><em>version</em></td>
<td><p>The host application&#39;s version.</p>
</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_SqlContext_HostDetails_Default.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Default%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs/#L40">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_SqlContext_HostDetails_Default" data-uid="Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Default">Default</h4>
<div class="markdown level1 summary"><p>The default host details in a HostDetails 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 readonly HostDetails Default</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_SqlContext_HostDetails_DefaultHostName.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostName%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs/#L22">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_SqlContext_HostDetails_DefaultHostName" data-uid="Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostName">DefaultHostName</h4>
<div class="markdown level1 summary"><p>The default host name for SqlTools Editor Services. Used
if no host name is specified by the host application.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string DefaultHostName = &quot;SqlTools Service Host&quot;</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_SqlContext_HostDetails_DefaultHostProfileId.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostProfileId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs/#L28">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_SqlContext_HostDetails_DefaultHostProfileId" data-uid="Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostProfileId">DefaultHostProfileId</h4>
<div class="markdown level1 summary"><p>The default host ID for SqlTools Editor Services. Used
for the host-specific profile path if no host ID is specified.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string DefaultHostProfileId = &quot;Microsoft.SqlToolsServiceHost&quot;</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_SqlContext_HostDetails_DefaultHostVersion.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostVersion%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs/#L35">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_SqlContext_HostDetails_DefaultHostVersion" data-uid="Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostVersion">DefaultHostVersion</h4>
<div class="markdown level1 summary"><p>The default host version for SqlTools Editor Services. If
no version is specified by the host application, we use 0.0.0
to indicate a lack of version.</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 Version DefaultHostVersion</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_SqlContext_HostDetails_Name.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Name%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs/#L49">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_SqlContext_HostDetails_Name" data-uid="Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Name">Name</h4>
<div class="markdown level1 summary"><p>Gets the name of the host.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Name { 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_SqlContext_HostDetails_ProfileId.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.ProfileId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs/#L55">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_SqlContext_HostDetails_ProfileId" data-uid="Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.ProfileId">ProfileId</h4>
<div class="markdown level1 summary"><p>Gets the profile ID of the host, used to determine the
host-specific profile path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ProfileId { 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_SqlContext_HostDetails_Version.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Version%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs/#L60">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_SqlContext_HostDetails_Version" data-uid="Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Version">Version</h4>
<div class="markdown level1 summary"><p>Gets the version of the host.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Version Version { 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.Version</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_SqlContext_HostDetails.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails%0Asummary%3A%20'*You%20can%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/SqlContext/HostDetails.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 &nbsp;//&nbsp; 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>
Reference in New Issue View Git Blame Copy Permalink