UIConnectionInfoUtil Class

Article
02/01/2013

Represents the utility functions for working with UIConnectionInfo objects.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public NotInheritable Class UIConnectionInfoUtil
'Usage
Dim instance As UIConnectionInfoUtil

public sealed class UIConnectionInfoUtil

public ref class UIConnectionInfoUtil sealed

[<SealedAttribute>]
type UIConnectionInfoUtil =  class end

public final class UIConnectionInfoUtil

The UIConnectionInfoUtil type exposes the following members.

Constructors

	Name	Description
	UIConnectionInfoUtil	Initializes a new instance of the UIConnectionInfoUtil class.

Top

Properties

	Name	Description
	ProtocolNamesMap	Represents a collection of key protocol values that are organized based on the hash code of the key.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	FillInRegisteredServerFromConnectionInfo	Retrieves the registered server settings from the connection information.
	GetAdditionalParams	Returns the additional parameters for the given connection.
	GetConnectionProtocol(UIConnectionGroupInfo)	Returns a SqlManagement Core NetworkProtocol object indicating the connection protocol from the first connection information in the list.
	GetConnectionProtocol(UIConnectionInfo)	Returns a SqlManagement Core NetworkProtocol object indicating the connection protocol that has the specified connection information.
	GetConnectionProtocol(String)	Returns a SqlManagement Core NetworkProtocol object indicating the connection protocol that has the specified protocol name.
	GetConnectionTimeout(UIConnectionGroupInfo)	Retrieves the connection timeout for a UIConnectionInfo object from the first connection info in the list with the specified list of connection information.
	GetConnectionTimeout(UIConnectionInfo)	Retrieves the connection timeout for a UIConnection object with the specified connection information.
	GetCoreConnectionInfo(UIConnectionGroupInfo)	Retrieves the enumerator style connection objects out of the specified UIConnectionInfo objects with the specified list of connection information.
	GetCoreConnectionInfo(UIConnectionInfo)	Retrieves the enumerator style connection object out of the specified UIConnectionInfo object with the specified source parameter.
	GetCoreConnectionInfo(UIConnectionGroupInfo, Boolean)	Retrieves the enumerator style connection object out of the specified UIConnectionInfo object from the first connection information in the list with the specified database parameter.
	GetCoreConnectionInfo(UIConnectionInfo, Boolean)	Retrieves the enumerator style connection object out of the specified UIConnectionInfo object with the specified source and database.
	GetCoreConnectionType(UIConnectionGroupInfo)	Retrieves the enumerator connection type that corresponds to the given UIConnectionInfo structure from the first connection information in the list.
	GetCoreConnectionType(UIConnectionInfo)	Retrieves enumerator connection type that corresponds to the given UIConnectionInfo structure.
	GetCustomConnectionColor	Retrieves the custom connection color with the specified connection information.
	GetDatabaseName(UIConnectionGroupInfo)	Retrieves the database name from the connection object with the specified connection information list.
	GetDatabaseName(UIConnectionInfo)	Retrieves the database name from the connection object with specified connection information.
	GetEncryptConnection(UIConnectionGroupInfo)	Returns whether the Encrypt connection option is specified from the first connection information list.
	GetEncryptConnection(UIConnectionInfo)	Returns whether the Encrypt connection option is specified or not with specified connection information.
	GetExecutionTimeout(UIConnectionGroupInfo)	Retrieves the execution timeout from the connection info from the specified connection information list.
	GetExecutionTimeout(UIConnectionInfo)	Retrieves the execution timeout from the connection information.
	GetHashCode	(Inherited from Object.)
	GetPacketSize(UIConnectionGroupInfo)	Returns packet size for SQL connection with the specified connection information list.
	GetPacketSize(UIConnectionInfo)	Returns packet size for SQL connection info encapsulated by UIConnectionInfo.
	GetServerType(ServerType)	Determines the type of server to get from UIConnectionInfo.
	GetServerType(UIConnectionInfo)	Determines the type of server to get from the UIConnectionInfo object.
	GetServerType(Guid)	Specifies the type of server to get from the UIConnectionInfo object.
	GetType	(Inherited from Object.)
	GetUIConnectionInfoFromConnectionString	Indicates the connection info to get from the specified connection string.
	GetUseCustomConnectionColor	Specifies the custom color to use for the UIConnectionInfo object.
	GetYukonUIConnectionInfoFromRegisteredServer	Indicates the YukonUIConnectionInfo settings to get from the registered server.
	IsWindowsAuthentication(UIConnectionGroupInfo)	Determines if the UIConnectionInfo object uses Windows Authentication with the specified connection info list parameter.
	IsWindowsAuthentication(UIConnectionInfo)	Determines if the UIConnectionInfo object uses Windows Authentication with the specified connection information.
	NewConnectionFromQEEvent(Object, UIConnectionGroupInfo)	Executes the NewConnectionFromQE event if somebody has subscribed to it with the specified sender and connection information list.
	NewConnectionFromQEEvent(Object, UIConnectionInfo)	Executes the NewConnectionFromQE event if somebody has subscribed to it with the sender and connection information.
	SetAdditionalParams	Sets the additional parameters for the given connection.
	SetConnectionProtocol(UIConnectionGroupInfo, NetworkProtocol)	Specifies the connection protocol for all connection information in the list with the specified protocol parameter.
	SetConnectionProtocol(UIConnectionInfo, NetworkProtocol)	Specifies the connection protocol for all connection information with the specified connection information and protocol parameter.
	SetConnectionProtocol(UIConnectionInfo, String)	Initiates the connection protocol settings.
	SetConnectionTimeout(UIConnectionGroupInfo, Int32)	Specifies the connection timeout value for a given UIConnectionInfo object with the specified connection information list and timeout parameter.
	SetConnectionTimeout(UIConnectionInfo, Int32)	Specifies the connection timeout value for a given UIConnectionInfo object with the specified with the specified connection information and timeout parameter.
	SetCustomConnectionColor	Stores CustomConnectionColor option in the specified UIConnectionInfo object.
	SetDatabaseName(UIConnectionGroupInfo, String)	Specifies the database name for all elements in the list of the UIConnectionInfo object.
	SetDatabaseName(UIConnectionInfo, String)	Specifies the database name for the passed UIConnectionInfo object.
	SetEncryptConnection(UIConnectionGroupInfo, Boolean)	Stores the encrypt connection option in the specified UIConnectionInfo object with the specified connection information in the list and encryption value.
	SetEncryptConnection(UIConnectionInfo, Boolean)	Stores the Encrypt connection option in the specified UIConnectionInfo object that has the specified connection information and encryption value.
	SetExecutionTimeout(UIConnectionGroupInfo, Int32)	Specifies the execution timeout value for all elements in the list of the UIConnectionInfo object.
	SetExecutionTimeout(UIConnectionInfo, Int32)	Specifies the execution timeout value for the given UIConnectionInfo object.
	SetPacketSize(UIConnectionGroupInfo, Int32)	Specifies packet size for all elements in the list of the UIConnectionInfo object with the specified size parameter.
	SetPacketSize(UIConnectionInfo, Int32)	Specifies packet size for SQL connection info encapsulated by the UIConnectionInfo object.
	SetUseCustomConnectionColor	Stores the UseCustomConnectionColor option in the specified UIConnectionInfo object.
	SetWindowsAuthentication(UIConnectionGroupInfo, Boolean)	Specifies whether to use Windows Authentication for all elements in the list of the UIConnectionInfo object.
	SetWindowsAuthentication(UIConnectionInfo, Boolean)	Specifies the UIConnectionInfo object to use Windows Authentication if enable.
	ToString	(Inherited from Object.)

Top

Events

	Name	Description
	NewConnectionFromQE	Occurs when the prototype of NewConnectionFromQE event that will be fired by QE part of SQL workbench when it establishes a new connection.

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