Article
10/01/2010

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
	ServerConnection()	Initializes a new instance of the ServerConnection class.
	ServerConnection(SqlConnection)	Initializes a new instance of the ServerConnection class with the specified connection parameters.
	ServerConnection(String)	Initializes a new instance of the ServerConnection class with the specified server instance.
	ServerConnection(SqlConnectionInfo)	Initializes a new instance of the ServerConnection class with the specified connection information.
	ServerConnection(String, String, SecureString)	Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.
	ServerConnection(String, String, String)	Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.

Top

Methods

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

Top

Properties

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

Top

Events

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