Improve this Doc View Source

Class ConnectionCompleteParams

Parameters to be sent back with a connection complete event

Inheritance
System.Object
ConnectionCompleteParams
Namespace:Microsoft.SqlTools.ServiceLayer.Connection.Contracts
Assembly:Microsoft.SqlTools.ServiceLayer.dll
Syntax
public class ConnectionCompleteParams

Properties

| Improve this Doc View Source

ConnectionId

A GUID representing a unique connection ID

Declaration
public string ConnectionId { get; set; }
Type Description
System.String
| Improve this Doc View Source

ConnectionSummary

Gets or sets the actual Connection established, including Database Name

Declaration
public ConnectionSummary ConnectionSummary { get; set; }
Type Description
ConnectionSummary
| Improve this Doc View Source

ErrorMessage

Error message returned from the engine for a connection failure reason, if any.

Declaration
public string ErrorMessage { get; set; }
Type Description
System.String
| Improve this Doc View Source

ErrorNumber

Error number returned from the engine for connection failure reason, if any.

Declaration
public int ErrorNumber { get; set; }
Type Description
System.Int32
| Improve this Doc View Source

Messages

Gets or sets any detailed connection error messages.

Declaration
public string Messages { get; set; }
Type Description
System.String
| Improve this Doc View Source

OwnerUri

A URI identifying the owner of the connection. This will most commonly be a file in the workspace or a virtual file representing an object in a database.

Declaration
public string OwnerUri { get; set; }
Type Description
System.String
| Improve this Doc View Source

ServerInfo

Information about the connected server.

Declaration
public ServerInfo ServerInfo { get; set; }
Type Description
ServerInfo