Share via


SqlConnectionInfo Class

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
Public method SqlConnectionInfo() Initializes a new instance of the SqlConnectionInfo class.
Public method SqlConnectionInfo(String) Initializes a new instance of the SqlConnectionInfo class.
Public method SqlConnectionInfo(SqlConnectionInfo) Initializes a new instance of the SqlConnectionInfo class.
Public method SqlConnectionInfo(ServerConnection, ConnectionType) Initializes a new instance of the SqlConnectionInfo class.
Public method SqlConnectionInfo(String, String, String) Initializes a new instance of the SqlConnectionInfo class.

Top

Properties

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

Top

Methods

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

Top

Fields

  Name Description
Public fieldStatic member 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.