SqlServerType Class

Article
02/01/2013

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

This API is not CLS-compliant.

Inheritance Hierarchy

System.Object
Microsoft.SqlServer.Management.UI.ConnectionDlg.SqlServerType

Namespace: Microsoft.SqlServer.Management.UI.ConnectionDlg
Assembly: ConnectionDlg (in ConnectionDlg.dll)

Syntax

'Declaration
<RegisterServerHelpKeyWordAttribute("sql11.swb.registerserver.general.sqlserver.f1")> _
<AdvancedViewHelpKeyWordAttribute("sql11.swb.connecttosqlserver.login.f1")> _
<CLSCompliantAttribute(False)> _
<HelpKeyWordAttribute("sql11.swb.connection.login.sqlserver.f1")> _
Public Class SqlServerType _
    Implements IServerType, IConnectionValidator
'Usage
Dim instance As SqlServerType

[RegisterServerHelpKeyWordAttribute("sql11.swb.registerserver.general.sqlserver.f1")]
[AdvancedViewHelpKeyWordAttribute("sql11.swb.connecttosqlserver.login.f1")]
[CLSCompliantAttribute(false)]
[HelpKeyWordAttribute("sql11.swb.connection.login.sqlserver.f1")]
public class SqlServerType : IServerType, 
    IConnectionValidator

[RegisterServerHelpKeyWordAttribute(L"sql11.swb.registerserver.general.sqlserver.f1")]
[AdvancedViewHelpKeyWordAttribute(L"sql11.swb.connecttosqlserver.login.f1")]
[CLSCompliantAttribute(false)]
[HelpKeyWordAttribute(L"sql11.swb.connection.login.sqlserver.f1")]
public ref class SqlServerType : IServerType, 
    IConnectionValidator

[<RegisterServerHelpKeyWordAttribute("sql11.swb.registerserver.general.sqlserver.f1")>]
[<AdvancedViewHelpKeyWordAttribute("sql11.swb.connecttosqlserver.login.f1")>]
[<CLSCompliantAttribute(false)>]
[<HelpKeyWordAttribute("sql11.swb.connection.login.sqlserver.f1")>]
type SqlServerType =  
    class 
        interface IServerType 
        interface IConnectionValidator 
    end

public class SqlServerType implements IServerType, IConnectionValidator

The SqlServerType type exposes the following members.

Constructors

	Name	Description
	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(array<Int32[])	Initializes a new instance of the SqlServerType class with specified supported authentication types.
	SqlServerType(array<Int32[], Decimal)	Initializes a new instance of the SqlServerType class with specified supported authentication types and default execution time-out value.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Fields

	Name	Description
	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	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	A String constant with the PROTOCOL value.
	PacketSize	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 Int, with a value of 1.
	SqlExpressEditionNumber	A constant of type Int, with a value of 4.
	TrustedAuthenticationType	A constant of type Int, with a value of 0.
	UseCustomConnectionColor	A String constant with the USE_CUSTOM_CONNECTION_COLOR value.

Top

Explicit Interface Implementations

	Name	Description
	IConnectionValidator.CheckConnection	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	Gets a table that contains the authentication labels that are used to populate the simple view of the connection dialog box.
	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	Retrieves a new IDbConnection object (closed) that is based on the passed UIConnectionInfo object.
	IServerType.LoadPersonalizationInfo	Loads any personalization information that is saved upon successful connection by using SavePersonalizationInfo.
	IServerType.ProceedWithConnection	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	Gets the size that the custom user control needs to render correctly. This is used by both the advanced view of the connection dialog box and the New Server Registration dialog box to ensure that they expose enough screen space for the whole control to be visible.
	IServerType.SavePersonalizationInfo	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	Gets the name of the server group root node for the server type.
	IServerType.ServerInstanceName	Gets the instance name of the server.
	IServerType.ServerType	Gets the server type for the instance of SQL Server.
	IServerType.ServerTypeName	Gets the string that is exposed to the user in the Server Type combo box.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via