IVsDataConnection Interface
Represents the interface for a data connection.
Namespace: Microsoft.VisualStudio.Data.Services
Assembly: Microsoft.VisualStudio.Data.Services (in Microsoft.VisualStudio.Data.Services.dll)
Syntax
'Declaration
Public Interface IVsDataConnection _
Inherits IVsDataConnectionEvents, IServiceProvider, IDisposable
public interface IVsDataConnection : IVsDataConnectionEvents,
IServiceProvider, IDisposable
public interface class IVsDataConnection : IVsDataConnectionEvents,
IServiceProvider, IDisposable
type IVsDataConnection =
interface
interface IVsDataConnectionEvents
interface IServiceProvider
interface IDisposable
end
public interface IVsDataConnection extends IVsDataConnectionEvents, IServiceProvider, IDisposable
The IVsDataConnection type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ConnectionTimeout | Gets or sets the amount of time to wait to establish a connection before terminating the attempt and generating a time-out error. |
|
CurrentThreadHasLock | Gets a value indicating whether the current thread has a lock on the data connection object. |
|
DisplayConnectionString | Gets the connection string in which sensitive information, if present, is formatted for secure display. |
|
EncryptedConnectionString | Gets an encrypted version of the connection string. |
|
IsLocked | Gets a value indicating whether the current data connection is locked. |
|
IsNonLocking | Gets a value indicating whether the data connection supports automatic locking. |
|
Provider | Gets the GUID of the data provider. |
|
SafeConnectionString | Gets the connection string, excluding sensitive information. |
|
Source | Gets the GUID of the data source for the current data connection, if any. |
|
State | Gets the current state of the data connection. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Clone() | Creates a copy of the current data connection. |
|
Clone(Boolean) | Creates a copy of the current data connection. |
|
Close | Closes the current data connection. |
|
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
|
EnsureConnected | Determines whether the current data connection is connected, and, if not, opens it. |
|
EquivalentTo | Indicates whether the given data connection information, as represented by the provider GUID and a connection string, is equivalent to the current instance of the data connection. |
|
GetLockedProviderObject() | Retrieves the underlying locked data provider that supports the current data connection. |
|
GetLockedProviderObject(Int32) | Retrieves the underlying data provider after locking the current data connection. |
|
GetService | Gets the service object of the specified type. (Inherited from IServiceProvider.) |
|
Lock() | Locks the current data connection. |
|
Lock(Int32) | Locks the current data connection. |
|
Open | Opens the current data connection. |
|
ReleaseExclusiveAccessProxy | Releases an existing exclusive access proxy. |
|
Unlock | Unlocks the current data connection. |
|
UnlockProviderObject | Unlocks the underlying provider object for the current data connection. |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
MessageReceived | Occurs when a message is received from the data source. (Inherited from IVsDataConnectionEvents.) |
|
StateChanged | Occurs when the state of the data connection is changed. (Inherited from IVsDataConnectionEvents.) |
Top
Remarks
This interface is implemented as a built-in DDEX service.