SqlServerType Class

Definition

Important

This API is not CLS-compliant.

Implements the connection dialog interfaces for Database Engine server type connections.

public ref class SqlServerType : Microsoft::SqlServer::Management::UI::ConnectionDlg::IConnectionValidator, Microsoft::SqlServer::Management::UI::ConnectionDlg::IServerType
[Microsoft.SqlServer.Management.UI.ConnectionDlg.AdvancedViewHelpKeyWord("sql13.swb.connecttosqlserver.login.f1")]
[Microsoft.SqlServer.Management.UI.ConnectionDlg.HelpKeyWord("sql13.swb.connection.login.sqlserver.f1")]
[Microsoft.SqlServer.Management.UI.ConnectionDlg.RegisterServerHelpKeyWord("sql13.swb.registerserver.general.sqlserver.f1")]
[System.CLSCompliant(false)]
public class SqlServerType : Microsoft.SqlServer.Management.UI.ConnectionDlg.IConnectionValidator, Microsoft.SqlServer.Management.UI.ConnectionDlg.IServerType
[<Microsoft.SqlServer.Management.UI.ConnectionDlg.AdvancedViewHelpKeyWord("sql13.swb.connecttosqlserver.login.f1")>]
[<Microsoft.SqlServer.Management.UI.ConnectionDlg.HelpKeyWord("sql13.swb.connection.login.sqlserver.f1")>]
[<Microsoft.SqlServer.Management.UI.ConnectionDlg.RegisterServerHelpKeyWord("sql13.swb.registerserver.general.sqlserver.f1")>]
[<System.CLSCompliant(false)>]
type SqlServerType = class
    interface IServerType
    interface IConnectionValidator
Public Class SqlServerType
Implements IConnectionValidator, IServerType
Inheritance
SqlServerType
Attributes
Implements

Constructors

SqlServerType()

Initializes a new instance of the SqlServerType class with the default property values.

SqlServerType(Decimal)

Initializes a new instance of the SqlServerType class with the specified default execution time-out value.

SqlServerType(Int32[])

Initializes a new instance of the SqlServerType class with specified supported authentication types.

SqlServerType(Int32[], Decimal)

Initializes a new instance of the SqlServerType class with specified supported authentication types and default execution time-out value.

Fields

ActiveDirectoryIntegratedAuthenticationType
ActiveDirectoryPasswordAuthenticationType
authCollection

Specifies the authentication information collection for the server.

ConnectionTimeout

A String constant with the CONNECTION_TIMEOUT value.

CustomConnectionColor

A String constant with the CUSTOM_CONNECTION_COLOR value.

Database

Specifies a String constant with the DATABASE value.

EncryptConnection

A String constant with the ENCRYPT_CONNECTION value.

ExecutionTimeout

A String constant with the EXEC_TIMEOUT value.

ExecutionTimeoutDisable

A String constant with the EXEC_TIMEOUT_DISABLE value.

NetworkProtocol

Specifies a String constant with the PROTOCOL value.

PacketSize

Specifies a String constant with the PACKET_SIZE value.

reqSize

Specifies the requested property size for the server.

serverInstanceName

Specifies the instance name for the server.

serverName

Specifies a string that represents the name of the server.

serverRootName

Specifies a string that represents the root name of the server.

ServerType

The GUID for the server type.

SqlAuthenticationType

A constant of type Int32, with a value of 1.

SqlExpressEditionNumber

A constant of type Int32, with a value of 4.

TrustedAuthenticationType

A constant of type Int32, with a value of 0.

TrustServerCertificate
UseCustomConnectionColor

A String constant with the USE_CUSTOM_CONNECTION_COLOR value.

Explicit Interface Implementations

IConnectionValidator.CheckConnection(IDbConnection)

Checks if successfully opened connection should be returned to the calling application Throws NotSupportedException exception if it should be bounced with error message as the exception text.

IServerType.AuthenticationInfoCollection
IServerType.GenerateImage()

Retrieves newly-instantiated icon that is displayed in the Registered Servers tree.

IServerType.GenerateUserControl()

Retrieves a newly-instantiated user control that is displayed on the Connection Properties tab of the advanced view of the connection dialog box.

IServerType.GetConnectionObject(UIConnectionInfo)

Retrieves a new IDbConnection object (closed) that is based on the passed UIConnectionInfo object.

IServerType.LoadPersonalizationInfo(UIConnectionInfo, Boolean)

Loads any personalization information that is saved upon successful connection by using SavePersonalizationInfo.

IServerType.ProceedWithConnection(UIConnectionInfo)

Used when a server type needs to perform additional processing steps. Indicates whether the connection can continue, or whether the connection dialog box should remain on the screen.

IServerType.RequestedPropertySize
IServerType.SavePersonalizationInfo(UIConnectionInfo)

Saves personalization information that may be needed for subsequent uses of the connection dialog box, such as the server type, server name, authentication type, and user name.

IServerType.ServerGroupName
IServerType.ServerInstanceName
IServerType.ServerType
IServerType.ServerTypeName

Applies to