Export (0) Print
Expand All

SqlServerType Class

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

This API is not CLS-compliant. 

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

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

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

The SqlServerType type exposes the following members.

  NameDescription
Public methodSqlServerType()Initializes a new instance of the SqlServerType class with the default property values.
Public methodSqlServerType(Decimal)Initializes a new instance of the SqlServerType class with the specified default execution time-out value.
Public methodSqlServerType(Int32[])Initializes a new instance of the SqlServerType class with specified supported authentication types.
Public methodSqlServerType(Int32[], Decimal)Initializes a new instance of the SqlServerType class with specified supported authentication types and default execution time-out value.
Top

  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top

  NameDescription
Protected fieldauthCollectionSpecifies the authentication information collection for the server.
Public fieldStatic memberConnectionTimeoutA String constant with the CONNECTION_TIMEOUT value.
Public fieldStatic memberCustomConnectionColorA String constant with the CUSTOM_CONNECTION_COLOR value.
Public fieldStatic memberDatabaseA String constant with the DATABASE value.
Public fieldStatic memberEncryptConnectionA String constant with the ENCRYPT_CONNECTION value.
Public fieldStatic memberExecutionTimeoutA String constant with the EXEC_TIMEOUT value.
Public fieldStatic memberExecutionTimeoutDisableA String constant with the EXEC_TIMEOUT_DISABLE value.
Public fieldStatic memberNetworkProtocolA String constant with the PROTOCOL value.
Public fieldStatic memberPacketSizeA String constant with the PACKET_SIZE value.
Protected fieldStatic memberreqSizeSpecifies the requested property size for the server.
Protected fieldserverInstanceNameSpecifies the instance name for the server.
Protected fieldserverNameSpecifies a string that represents the name of the server.
Protected fieldserverRootNameSpecifies a string that represents the root name of the server.
Public fieldStatic memberServerTypeThe GUID for the server type.
Public fieldStatic memberSqlAuthenticationTypeA constant of type Int, with a value of 1.
Public fieldStatic memberSqlExpressEditionNumberA constant of type Int, with a value of 4.
Public fieldStatic memberTrustedAuthenticationTypeA constant of type Int, with a value of 0.
Public fieldStatic memberUseCustomConnectionColorA String constant with the USE_CUSTOM_CONNECTION_COLOR value.
Top

  NameDescription
Explicit interface implemetationPrivate methodIConnectionValidator.CheckConnectionChecks 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.
Explicit interface implemetationPrivate propertyIServerType.AuthenticationInfoCollectionGets a table that contains the authentication labels that are used to populate the simple view of the connection dialog box.
Explicit interface implemetationPrivate methodIServerType.GenerateImageRetrieves newly-instantiated icon that is displayed in the Registered Servers tree.
Explicit interface implemetationPrivate methodIServerType.GenerateUserControlRetrieves a newly-instantiated user control that is displayed on the Connection Properties tab of the advanced view of the connection dialog box.
Explicit interface implemetationPrivate methodIServerType.GetConnectionObjectRetrieves a new IDbConnection object (closed) that is based on the passed UIConnectionInfo object.
Explicit interface implemetationPrivate methodIServerType.LoadPersonalizationInfoLoads any personalization information that is saved upon successful connection by using SavePersonalizationInfo.
Explicit interface implemetationPrivate methodIServerType.ProceedWithConnectionUsed 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.
Explicit interface implemetationPrivate propertyIServerType.RequestedPropertySizeGets 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.
Explicit interface implemetationPrivate methodIServerType.SavePersonalizationInfoSaves 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.
Explicit interface implemetationPrivate propertyIServerType.ServerGroupNameGets the name of the server group root node for the server type.
Explicit interface implemetationPrivate propertyIServerType.ServerInstanceNameGets the instance name of the server.
Explicit interface implemetationPrivate propertyIServerType.ServerTypeGets the server type for the instance of SQL Server.
Explicit interface implemetationPrivate propertyIServerType.ServerTypeNameGets the string that is exposed to the user in the Server Type combo box.
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft