• Article

ServerConnection Members

Include Protected Members
Include Inherited Members

The ServerConnection object represents a connection to a server.

The ServerConnection type exposes the following members.

Constructors

  Name Description
Public method ServerConnection() Initializes a new instance of the ServerConnection class.
Public method ServerConnection(SqlConnection) Initializes a new instance of the ServerConnection class with the specified connection parameters.
Public method ServerConnection(String) Initializes a new instance of the ServerConnection class with the specified server instance.
Public method ServerConnection(SqlConnectionInfo) Initializes a new instance of the ServerConnection class with the specified connection information.
Public method ServerConnection(String, String, SecureString) Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.
Public method ServerConnection(String, String, String) Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.

Top

Methods

  Name Description
Public method BeginTransaction() Starts a transaction on the referenced connection.
Public method Cancel() Cancels the connection.
Public method ChangePassword(SecureString) Changes the login password that is used with standard authentication.
Public method ChangePassword(String) Changes the logon password that is used with standard authentication.
Protected method CheckServerVersion(ServerVersion) Checks the version of the target instance of SQL Server. (Inherited from ConnectionManager.)
Public method CommitTransaction() Commits the current transaction on the referenced connection.
Public method Connect() Connects to the instance of SQL Server. (Inherited from ConnectionManager.)
Public method Copy() Returns a copy of the ServerConnection object.
Public method Disconnect() Disconnects from the instance of SQL Server. (Inherited from ConnectionManager.)
Public method Equals(Object) (Inherited from Object.)
Public method ExecuteNonQuery(StringCollection) Executes a batch of statements that do not return a result set.
Public method ExecuteNonQuery(String) Executes a statement that does not return a result set.
Public method ExecuteNonQuery(StringCollection, ExecutionTypes) Executes a batch of statements with the specified execution options that does not return a result set.
Public method ExecuteNonQuery(String, ExecutionTypes) Executes a statement with the specified execution options that does not return a result set.
Public method ExecuteReader(String) Executes Transact-SQL statements that return one or multiple result sets.
Public method ExecuteScalar(StringCollection) Executes a batch of Transact-SQL statements and returns the first column of the first row as an object value.
Public method ExecuteScalar(String) Executes a Transact-SQL statement and returns the first column of the first row as an object value.
Public method ExecuteWithResults(StringCollection) Executes a batch of Transact-SQL statements that return multiple result sets.
Public method ExecuteWithResults(String) Executes a Transact-SQL statement that returns a result set.
Protected method Finalize() (Inherited from Object.)
Public method GetHashCode() (Inherited from Object.)
Public method GetType() (Inherited from Object.)
Public method IsInFixedServerRole(FixedServerRoles) Tests whether the logon associated with the referenced connection is a member of the specified fixed server role.
Protected method MemberwiseClone() (Inherited from Object.)
Public methodStatic member NormalizeQuery(String)
Public methodStatic member NormalizeQuery(String, Boolean)
Public method RollBackTransaction() Rolls back the current transaction.
Protected method ThrowIfPropertyNotSet(String, String) Throws an exception if the specified connection property is null or empty. (Inherited from ConnectionSettings.)
Protected method ThrowIfPropertyNotSet(String, String, Boolean) Throws an exception if the specified connection property is null or, optionally, empty. (Inherited from ConnectionSettings.)
Public method ToString() Returns the referenced object name as a string. (Inherited from ConnectionSettings.)

Top

Properties

  Name Description
Public property ApplicationName Gets or sets the name of the application that has established the connection with the server. (Inherited from ConnectionSettings.)
Public property AutoDisconnectMode Gets or sets the automatic disconnection mode of the referenced connection to the instance of SQL Server. (Inherited from ConnectionManager.)
Public property BatchSeparator Gets or sets the string value used to separate batches in the referenced connection.
Public property CapturedSql Gets the Transact-SQL statements that are captured when the connection is running in capture mode. (Inherited from ConnectionManager.)
Public property ConnectAsUser Gets or sets the Boolean property value that specifies whether the connection is established using impersonation. (Inherited from ConnectionSettings.)
Public property ConnectAsUserName Gets or sets the name of the user when connecting using impersonation. (Inherited from ConnectionSettings.)
Public property ConnectAsUserPassword Gets or sets the password for the user when connecting using impersonation. (Inherited from ConnectionSettings.)
Public property ConnectionString Gets or sets the connection string used to establish a connection with a specified data source. (Inherited from ConnectionSettings.)
Public property ConnectionType
Public property ConnectTimeout Gets or sets the connection time-out period in seconds. (Inherited from ConnectionSettings.)
Public property DatabaseName Gets or sets the database required by the connection. (Inherited from ConnectionSettings.)
Public property EncryptConnection Gets or sets the Boolean property value that specifies whether the connection is encrypted. (Inherited from ConnectionSettings.)
Public property FixedServerRoles Gets the fixed server role associated with the referenced connection.
Public property InUse Gets or sets the Boolean property value that specifies whether the connection is being used. (Inherited from ConnectionManager.)
Public property IsOpen Gets the Boolean property value that specifies whether the connection is currently open. (Inherited from ConnectionManager.)
Public property LockTimeout Gets or sets the time in seconds required for the connection to time out when the current transaction is locked. (Inherited from ConnectionManager.)
Public property Login Gets or sets the logon required to establish a connection with the instance of the server. (Inherited from ConnectionSettings.)
Public property 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. (Inherited from ConnectionSettings.)
Public property 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. (Inherited from ConnectionSettings.)
Public property 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. (Inherited from ConnectionSettings.)
Public property MultipleActiveResultSets Gets or sets the Boolean property value that specifies whether more than one active result set is permitted. (Inherited from ConnectionSettings.)
Public property NetworkProtocol Gets or sets the network protocol used to establish the connection to the server. (Inherited from ConnectionSettings.)
Public property NonPooledConnection Gets or sets the Boolean property value that specifies whether the connection may be pooled or nonpooled. (Inherited from ConnectionSettings.)
Public property PacketSize Gets or sets the packets of data sent between the client and the server over the network in bytes. (Inherited from ConnectionSettings.)
Public propertyStatic member ParameterizationMode
Public property Password Gets or sets the password used with the logon to establish a connection with the server when SQL Server Authentication is used. (Inherited from ConnectionSettings.)
Public property PooledConnectionLifetime Gets or sets the lifetime of the pooled connection. (Inherited from ConnectionSettings.)
Public property ProcessID Gets the ID value that uniquely identifies the process associated with the referenced connection to the server.
Public property SecureConnectionString Gets or sets an encrypted version of the connection string. (Inherited from ConnectionSettings.)
Public property SecurePassword Gets or sets the secure password used with the logon to establish a connection with the server when SQL Server Authentication is used. (Inherited from ConnectionSettings.)
Public property ServerInstance Gets or sets the name of the server. (Inherited from ConnectionSettings.)
Public property ServerVersion Gets the version of the connected instance of SQL Server. (Inherited from ConnectionManager.)
Public property SqlConnectionObject Gets the connection object. (Inherited from ConnectionManager.)
Public property SqlExecutionModes Gets or sets the execution mode associated with the referenced connection to the server.
Public property StatementTimeout Gets or sets the number of seconds a statement is given to run before failing with a time-out error.
Public property TransactionDepth Gets the current transaction depth for the referenced connection.
Public property TrueLogin Gets the current logon record name used by the referenced connection.
Public property TrueName Gets the name of the server.
Public propertyStatic member UseMode
Public property UserProfile Gets the user profile associated with the referenced connection.
Public property WorkstationId Gets or sets the ID value that uniquely identifies the workstation. (Inherited from ConnectionSettings.)

Top

Events

  Name Description
Public event InfoMessage The event that occurs when the instance of SQL Server generates an informational message. (Inherited from ConnectionManager.)
Public event RemoteLoginFailed This event occurs when a remote login fails to connect to the instance of SQL Server. (Inherited from ConnectionManager.)
Public event ServerMessage The event that occurs when SQL Server returns a warning or informational message on the current connection. (Inherited from ConnectionManager.)
Public event StateChange The event that occurs when the instance of SQL Server changes state. (Inherited from ConnectionManager.)
Public event StatementExecuted The event that occurs when the instance of SQL Server executes a statement on the current connection. (Inherited from ConnectionManager.)

Top