ConnectionSettings Class

The ConnectionSettings class represents the settings used by a connection to an instance of a server, such as SQL Server. The ServerConnection class inherits ConnectionSettings class.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Common.ConnectionSettings
    Microsoft.SqlServer.Management.Common.ConnectionManager

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

Syntax

'Declaration
Public Class ConnectionSettings
'Usage
Dim instance As ConnectionSettings

public class ConnectionSettings

public ref class ConnectionSettings

type ConnectionSettings =  class end

public class ConnectionSettings

The ConnectionSettings type exposes the following members.

Properties

	Name	Description
	ApplicationName	Gets or sets the name of the application that has established the connection with the server.
	ConnectAsUser	Gets or sets the Boolean property value that specifies whether the connection is established using impersonation.
	ConnectAsUserName	Gets or sets the name of the user when connecting using impersonation.
	ConnectAsUserPassword	Gets or sets the password for the user when connecting using impersonation.
	ConnectionString	Gets or sets the connection string used to establish a connection with a specified data source.
	ConnectTimeout	Gets or sets the connection time-out period in seconds.
	DatabaseName	Gets or sets the database required by the connection.
	EncryptConnection	Gets or sets the Boolean property value that specifies whether the connection is encrypted.
	Login	Gets or sets the logon required to establish a connection with the instance of the server.
	LoginSecure	Gets or sets the Boolean property that specifies whether the connection is established to the server by using Windows Authentication or SQL Server Authentication.
	MaxPoolSize	Gets or sets the maximum number of connections in a connection pool that the specified connection accepts when establishing a connection with a server.
	MinPoolSize	Gets or sets the minimum number of connections in a connection pool that the specified connection accepts when establishing a connection with a server.
	MultipleActiveResultSets	Gets or sets the Boolean property value that specifies whether more than one active result set is permitted.
	NetworkProtocol	Gets or sets the network protocol used to establish the connection to the server.
	NonPooledConnection	Gets or sets the Boolean property value that specifies whether the connection may be pooled or nonpooled.
	PacketSize	Gets or sets the packets of data sent between the client and the server over the network in bytes.
	Password	Gets or sets the password used with the logon to establish a connection with the server when SQL Server Authentication is used.
	PooledConnectionLifetime	Gets or sets the lifetime of the pooled connection.
	ResetConnectionString	Gets or sets a Boolean value that specifies whether a node in the connection string has been changed.
	SecureConnectionString	Gets or sets an encrypted version of the connection string.
	SecurePassword	Gets or sets the secure password used with the logon to establish a connection with the server when SQL Server Authentication is used.
	ServerInstance	Gets or sets the name of the server.
	WorkstationId	Gets or sets the ID value that uniquely identifies the workstation.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ThrowIfPropertyNotSet(String, String)	Throws an exception if the specified connection property is null or empty.
	ThrowIfPropertyNotSet(String, String, Boolean)	Throws an exception if the specified connection property is null or, optionally, empty.
	ToString	Returns the referenced object name as a string. (Overrides Object.ToString().)

Top

Fields

	Name	Description
	NoConnectionTimeout	Gets or sets the Int32 value that specifies the time the connection takes to time out in seconds.

Top

Remarks

Thread Safety

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

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.

See Also

Reference

Microsoft.SqlServer.Management.Common Namespace