SqlConnectionInfo Class

Article
08/11/2014

The SqlConnectionInfo object represents information that is required to establish a connection to an instance of SQL Server.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Common.ConnectionInfoBase
    Microsoft.SqlServer.Management.Common.SqlOlapConnectionInfoBase
      Microsoft.SqlServer.Management.Common.SqlConnectionInfo

Namespace: Microsoft.SqlServer.Management.Common
Assembly: Microsoft.SqlServer.ConnectionInfo (in Microsoft.SqlServer.ConnectionInfo.dll)

Syntax

'Declaration
<SerializableAttribute> _
<ComVisibleAttribute(False)> _
Public Class SqlConnectionInfo _
    Inherits SqlOlapConnectionInfoBase
'Usage
Dim instance As SqlConnectionInfo

[SerializableAttribute]
[ComVisibleAttribute(false)]
public class SqlConnectionInfo : SqlOlapConnectionInfoBase

[SerializableAttribute]
[ComVisibleAttribute(false)]
public ref class SqlConnectionInfo : public SqlOlapConnectionInfoBase

[<SerializableAttribute>]
[<ComVisibleAttribute(false)>]
type SqlConnectionInfo =  
    class 
        inherit SqlOlapConnectionInfoBase 
    end

public class SqlConnectionInfo extends SqlOlapConnectionInfoBase

The SqlConnectionInfo type exposes the following members.

Constructors

	Name	Description
	SqlConnectionInfo()	Initializes a new instance of the SqlConnectionInfo class.
	SqlConnectionInfo(String)	Initializes a new instance of the SqlConnectionInfo class.
	SqlConnectionInfo(SqlConnectionInfo)	Initializes a new instance of the SqlConnectionInfo class.
	SqlConnectionInfo(ServerConnection, ConnectionType)	Initializes a new instance of the SqlConnectionInfo class.
	SqlConnectionInfo(String, String, String)	Initializes a new instance of the SqlConnectionInfo class.

Top

Properties

	Name	Description
	AdditionalParameters	Gets or sets the additional parameters for the connection.
	ApplicationName	Gets or sets the name of the application that is connected to the instance of SQL Server.
	ConnectionProtocol	Gets or sets the network protocol used by the connection to the instance of SQL Server.
	ConnectionString	Gets the connection string used when the connection is established with the instance of SQL Server. (Overrides SqlOlapConnectionInfoBase.ConnectionString.)
	ConnectionStringInternal	Gets or sets the internal connection string. (Inherited from SqlOlapConnectionInfoBase.)
	ConnectionTimeout	Gets or sets the number of seconds before a connection times out. (Inherited from SqlOlapConnectionInfoBase.)
	ConnectionTimeoutInternal	Gets or sets the internal connection timeout period in seconds. (Inherited from SqlOlapConnectionInfoBase.)
	DatabaseName	Gets or sets the database with which the connection is established. (Inherited from SqlOlapConnectionInfoBase.)
	DatabaseNameInternal	Gets or sets the internal database name. (Inherited from SqlOlapConnectionInfoBase.)
	EncryptConnection	Gets or sets the Boolean property value that specifies whether the connection information is encrypted.
	IntegratedSecurityInternal	Gets or sets the Boolean property value that specifies whether the connection supports integrated security. (Inherited from SqlOlapConnectionInfoBase.)
	MaxPoolSize	Gets or sets the maximum number of execution threads in a thread pool that the connection will accept.
	MinPoolSize	Gets or sets the minimum number of execution threads in a thread pool that the connection will accept.
	PacketSize	Gets or sets the network packet size used by the connection to send and receive data in bytes.
	Password	Gets or sets the password used to establish a connection. (Inherited from SqlOlapConnectionInfoBase.)
	PoolConnectionLifeTime	Gets or sets the pool connection period in seconds.
	Pooled	Gets or sets the SqlBoolean property value that specifies whether the connection is pooled.
	QueryTimeout	Gets or sets the number of seconds before a query times out. (Inherited from SqlOlapConnectionInfoBase.)
	QueryTimeoutInternal	Gets or sets the internal query timeout period in seconds. (Inherited from SqlOlapConnectionInfoBase.)
	RebuildConnectionStringInternal	Gets or sets a Boolean indicating whether the internal connection string must be rebuilt. (Inherited from SqlOlapConnectionInfoBase.)
	SecurePassword	Gets or sets the secure password used to establish a connection. (Inherited from SqlOlapConnectionInfoBase.)
	ServerCaseSensitivity	Gets or sets the server case sensitivity for the connection. (Inherited from ConnectionInfoBase.)
	ServerName	Gets or sets the name of the instance of SQL Server. (Inherited from SqlOlapConnectionInfoBase.)
	ServerNameInternal	Gets or sets the internal name of the instance of SQL Server. (Inherited from SqlOlapConnectionInfoBase.)
	ServerType	Gets or sets the server connection type. (Inherited from ConnectionInfoBase.)
	ServerVersion	Gets or sets the version information about the instance of SQL Server. (Inherited from ConnectionInfoBase.)
	UseIntegratedSecurity	Gets or sets the Boolean property value that specifies whether the connection uses integrated security. (Inherited from SqlOlapConnectionInfoBase.)
	UserName	Gets or sets the user that is connecting to the instance of SQL Server. (Inherited from SqlOlapConnectionInfoBase.)
	WorkstationId	Gets or sets the value that uniquely identifies the client workstation.

Top

Methods

	Name	Description
	ConnectionParmsChanged	Changes the connection parameters. (Inherited from SqlOlapConnectionInfoBase.)
	Copy	Returns a copy of the SqlConnectionInfo object.
	CreateConnectionObject	Creates a system connection object. (Overrides SqlOlapConnectionInfoBase.CreateConnectionObject().)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	Returns the SqlConnectionInfo object in string format. (Overrides SqlOlapConnectionInfoBase.ToString().)

Top

Fields

	Name	Description
	DefaultNetworkProtocol	The NetworkProtocol object that specifies the default network protocol for the connection.

Top

Remarks

The SqlConnectionInfo object can be passed as a parameter when constructing the ServerConnection object to provide connection information.

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