Export (0) Print
Expand All

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.

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)

public class ConnectionSettings

The ConnectionSettings type exposes the following members.

  NameDescription
Public propertyApplicationNameGets or sets the name of the application that has established the connection with the server.
Public propertyConnectAsUserGets or sets the Boolean property value that specifies whether the connection is established using impersonation.
Public propertyConnectAsUserNameGets or sets the name of the user when connecting using impersonation.
Public propertyConnectAsUserPasswordGets or sets the password for the user when connecting using impersonation.
Public propertyConnectionStringGets or sets the connection string used to establish a connection with a specified data source.
Public propertyConnectTimeoutGets or sets the connection time-out period in seconds.
Public propertyDatabaseNameGets or sets the database required by the connection.
Public propertyEncryptConnectionGets or sets the Boolean property value that specifies whether the connection is encrypted.
Public propertyLoginGets or sets the logon required to establish a connection with the instance of the server.
Public propertyLoginSecureGets or sets the Boolean property that specifies whether the connection is established to the server by using Windows Authentication or SQL Server Authentication.
Public propertyMaxPoolSizeGets or sets the maximum number of connections in a connection pool that the specified connection accepts when establishing a connection with a server.
Public propertyMinPoolSizeGets or sets the minimum number of connections in a connection pool that the specified connection accepts when establishing a connection with a server.
Public propertyMultipleActiveResultSetsGets or sets the Boolean property value that specifies whether more than one active result set is permitted.
Public propertyNetworkProtocolGets or sets the network protocol used to establish the connection to the server.
Public propertyNonPooledConnectionGets or sets the Boolean property value that specifies whether the connection may be pooled or nonpooled.
Public propertyPacketSizeGets or sets the packets of data sent between the client and the server over the network in bytes.
Public propertyPasswordGets or sets the password used with the logon to establish a connection with the server when SQL Server Authentication is used.
Public propertyPooledConnectionLifetimeGets or sets the lifetime of the pooled connection.
Protected propertyResetConnectionStringGets or sets a Boolean value that specifies whether a node in the connection string has been changed.
Public propertySecureConnectionStringGets or sets an encrypted version of the connection string.
Public propertySecurePasswordGets or sets the secure password used with the logon to establish a connection with the server when SQL Server Authentication is used.
Public propertyServerInstanceGets or sets the name of the server.
Public propertyWorkstationIdGets or sets the ID value that uniquely identifies the workstation.
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.)
Protected methodThrowIfPropertyNotSet(String, String)Throws an exception if the specified connection property is null or empty.
Protected methodThrowIfPropertyNotSet(String, String, Boolean)Throws an exception if the specified connection property is null or, optionally, empty.
Public methodToStringReturns the referenced object name as a string. (Overrides Object.ToString().)
Top

  NameDescription
Public fieldStatic memberNoConnectionTimeoutGets or sets the Int32 value that specifies the time the connection takes to time out in seconds.
Top

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft