ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-22 09:35:38 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
e3c080b2a06ec24ac39b9664a414fa494f61a361
sqltoolsservice/docs/metadata/api/Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.yml
Karl Burtram e3c080b2a0 Add initial doxfx content
2016-12-15 16:37:50 -08:00

696 lines
22 KiB
YAML
Raw Blame History

### YamlMime:ManagedReference
items:
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
commentId: T:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
id: HostDetails
parent: Microsoft.SqlTools.ServiceLayer.SqlContext
children:
- Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.#ctor(System.String,System.String,System.Version)
- Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Default
- Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostName
- Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostProfileId
- Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostVersion
- Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Name
- Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.ProfileId
- Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Version
langs:
- csharp
- vb
name: HostDetails
nameWithType: HostDetails
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
type: Class
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: HostDetails
path: ../src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
startLine: 13
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.SqlContext
summary: "\nContains details about the current host application (most\nlikely the editor which is using the host process).\n"
example: []
syntax:
content: public class HostDetails
content.vb: Public Class HostDetails
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
modifiers.csharp:
- public
- class
modifiers.vb:
- Public
- Class
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostName
commentId: F:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostName
id: DefaultHostName
parent: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
langs:
- csharp
- vb
name: DefaultHostName
nameWithType: HostDetails.DefaultHostName
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostName
type: Field
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: DefaultHostName
path: ../src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
startLine: 21
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.SqlContext
summary: "\nThe default host name for SqlTools Editor Services. Used\nif no host name is specified by the host application.\n"
example: []
syntax:
content: public const string DefaultHostName = "SqlTools Service Host"
content.vb: Public Const DefaultHostName As String = "SqlTools Service Host"
return:
type: System.String
modifiers.csharp:
- public
- const
modifiers.vb:
- Public
- Const
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostProfileId
commentId: F:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostProfileId
id: DefaultHostProfileId
parent: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
langs:
- csharp
- vb
name: DefaultHostProfileId
nameWithType: HostDetails.DefaultHostProfileId
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostProfileId
type: Field
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: DefaultHostProfileId
path: ../src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
startLine: 27
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.SqlContext
summary: "\nThe default host ID for SqlTools Editor Services. Used\nfor the host-specific profile path if no host ID is specified.\n"
example: []
syntax:
content: public const string DefaultHostProfileId = "Microsoft.SqlToolsServiceHost"
content.vb: Public Const DefaultHostProfileId As String = "Microsoft.SqlToolsServiceHost"
return:
type: System.String
modifiers.csharp:
- public
- const
modifiers.vb:
- Public
- Const
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostVersion
commentId: F:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostVersion
id: DefaultHostVersion
parent: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
langs:
- csharp
- vb
name: DefaultHostVersion
nameWithType: HostDetails.DefaultHostVersion
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.DefaultHostVersion
type: Field
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: DefaultHostVersion
path: ../src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
startLine: 34
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.SqlContext
summary: "\nThe default host version for SqlTools Editor Services. If\nno version is specified by the host application, we use 0.0.0\nto indicate a lack of version.\n"
example: []
syntax:
content: public static readonly Version DefaultHostVersion
content.vb: Public Shared ReadOnly DefaultHostVersion As Version
return:
type: System.Version
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Default
commentId: F:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Default
id: Default
parent: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
langs:
- csharp
- vb
name: Default
nameWithType: HostDetails.Default
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Default
type: Field
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: Default
path: ../src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
startLine: 39
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.SqlContext
summary: "\nThe default host details in a HostDetails object.\n"
example: []
syntax:
content: public static readonly HostDetails Default
content.vb: Public Shared ReadOnly Default As HostDetails
return:
type: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Name
commentId: P:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Name
id: Name
parent: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
langs:
- csharp
- vb
name: Name
nameWithType: HostDetails.Name
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Name
type: Property
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: Name
path: ../src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
startLine: 48
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.SqlContext
summary: "\nGets the name of the host.\n"
example: []
syntax:
content: public string Name { get; }
content.vb: Public ReadOnly Property Name As String
parameters: []
return:
type: System.String
overload: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Name*
modifiers.csharp:
- public
- get
modifiers.vb:
- Public
- ReadOnly
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.ProfileId
commentId: P:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.ProfileId
id: ProfileId
parent: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
langs:
- csharp
- vb
name: ProfileId
nameWithType: HostDetails.ProfileId
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.ProfileId
type: Property
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: ProfileId
path: ../src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
startLine: 54
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.SqlContext
summary: "\nGets the profile ID of the host, used to determine the\nhost-specific profile path.\n"
example: []
syntax:
content: public string ProfileId { get; }
content.vb: Public ReadOnly Property ProfileId As String
parameters: []
return:
type: System.String
overload: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.ProfileId*
modifiers.csharp:
- public
- get
modifiers.vb:
- Public
- ReadOnly
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Version
commentId: P:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Version
id: Version
parent: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
langs:
- csharp
- vb
name: Version
nameWithType: HostDetails.Version
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Version
type: Property
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: Version
path: ../src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
startLine: 59
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.SqlContext
summary: "\nGets the version of the host.\n"
example: []
syntax:
content: public Version Version { get; }
content.vb: Public ReadOnly Property Version As Version
parameters: []
return:
type: System.Version
overload: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Version*
modifiers.csharp:
- public
- get
modifiers.vb:
- Public
- ReadOnly
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.#ctor(System.String,System.String,System.Version)
commentId: M:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.#ctor(System.String,System.String,System.Version)
id: '#ctor(System.String,System.String,System.Version)'
parent: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
langs:
- csharp
- vb
name: HostDetails(String, String, Version)
nameWithType: HostDetails.HostDetails(String, String, Version)
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.HostDetails(System.String, System.String, System.Version)
type: Constructor
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: .ctor
path: ../src/Microsoft.SqlTools.ServiceLayer/SqlContext/HostDetails.cs
startLine: 79
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.SqlContext
summary: "\nCreates an instance of the HostDetails class.\n"
example: []
syntax:
content: public HostDetails(string name = null, string profileId = null, Version version = null)
content.vb: Public Sub New(name As String = Nothing, profileId As String = Nothing, version As Version = Nothing)
parameters:
- id: name
type: System.String
description: "\nThe display name for the host, typically in the form of\n\"[Application Name] Host\".\n"
- id: profileId
type: System.String
description: "\nThe identifier of the SqlTools host to use for its profile path.\nloaded. Used to resolve a profile path of the form 'X_profile.ps1'\nwhere 'X' represents the value of hostProfileId. If null, a default\nwill be used.\n"
- id: version
type: System.Version
description: The host application's version.
overload: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.#ctor*
modifiers.csharp:
- public
modifiers.vb:
- Public
references:
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext
commentId: N:Microsoft.SqlTools.ServiceLayer.SqlContext
isExternal: false
name: Microsoft.SqlTools.ServiceLayer.SqlContext
nameWithType: Microsoft.SqlTools.ServiceLayer.SqlContext
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
name: Object
nameWithType: Object
fullName: System.Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
name: Equals(Object)
nameWithType: Object.Equals(Object)
fullName: System.Object.Equals(System.Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
nameWithType: Object.Equals
fullName: System.Object.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
nameWithType: Object.Equals
fullName: System.Object.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
name: Equals(Object, Object)
nameWithType: Object.Equals(Object, Object)
fullName: System.Object.Equals(System.Object, System.Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
nameWithType: Object.Equals
fullName: System.Object.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
nameWithType: Object.Equals
fullName: System.Object.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
name: GetHashCode()
nameWithType: Object.GetHashCode()
fullName: System.Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
nameWithType: Object.GetHashCode
fullName: System.Object.GetHashCode
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
nameWithType: Object.GetHashCode
fullName: System.Object.GetHashCode
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
name: GetType()
nameWithType: Object.GetType()
fullName: System.Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
nameWithType: Object.GetType
fullName: System.Object.GetType
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.GetType
name: GetType
nameWithType: Object.GetType
fullName: System.Object.GetType
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
name: MemberwiseClone()
nameWithType: Object.MemberwiseClone()
fullName: System.Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
nameWithType: Object.MemberwiseClone
fullName: System.Object.MemberwiseClone
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
nameWithType: Object.MemberwiseClone
fullName: System.Object.MemberwiseClone
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
name: ReferenceEquals(Object, Object)
nameWithType: Object.ReferenceEquals(Object, Object)
fullName: System.Object.ReferenceEquals(System.Object, System.Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
nameWithType: Object.ReferenceEquals
fullName: System.Object.ReferenceEquals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
nameWithType: Object.ReferenceEquals
fullName: System.Object.ReferenceEquals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
name: ToString()
nameWithType: Object.ToString()
fullName: System.Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
nameWithType: Object.ToString
fullName: System.Object.ToString
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.ToString
name: ToString
nameWithType: Object.ToString
fullName: System.Object.ToString
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System
commentId: N:System
isExternal: false
name: System
nameWithType: System
fullName: System
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
name: String
nameWithType: String
fullName: System.String
- uid: System.Version
commentId: T:System.Version
parent: System
isExternal: true
name: Version
nameWithType: Version
fullName: System.Version
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
commentId: T:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
parent: Microsoft.SqlTools.ServiceLayer.SqlContext
isExternal: false
name: HostDetails
nameWithType: HostDetails
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Name*
commentId: Overload:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Name
isExternal: false
name: Name
nameWithType: HostDetails.Name
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Name
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.ProfileId*
commentId: Overload:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.ProfileId
isExternal: false
name: ProfileId
nameWithType: HostDetails.ProfileId
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.ProfileId
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Version*
commentId: Overload:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Version
isExternal: false
name: Version
nameWithType: HostDetails.Version
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.Version
- uid: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.#ctor*
commentId: Overload:Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.#ctor
isExternal: false
name: HostDetails
nameWithType: HostDetails.HostDetails
fullName: Microsoft.SqlTools.ServiceLayer.SqlContext.HostDetails.HostDetails
Reference in New Issue View Git Blame Copy Permalink