Partager via

IVsDataConnection Interface

  • Article

Represents the interface for a data connection.

Namespace:  Microsoft.VisualStudio.Data.Services
Assembly:  Microsoft.VisualStudio.Data.Services (in Microsoft.VisualStudio.Data.Services.dll)

Syntax

'Déclaration
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
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.
Public property CurrentThreadHasLock Gets a value indicating whether the current thread has a lock on the data connection object.
Public property DisplayConnectionString Gets the connection string in which sensitive information, if present, is formatted for secure display.
Public property EncryptedConnectionString Gets an encrypted version of the connection string.
Public property IsLocked Gets a value indicating whether the current data connection is locked.
Public property IsNonLocking Gets a value indicating whether the data connection supports automatic locking.
Public property Provider Gets the GUID of the data provider.
Public property SafeConnectionString Gets the connection string, excluding sensitive information.
Public property Source Gets the GUID of the data source for the current data connection, if any.
Public property State Gets the current state of the data connection.

Top

Methods

  Name Description
Public method Clone() Creates a copy of the current data connection.
Public method Clone(Boolean) Creates a copy of the current data connection.
Public method Close Closes the current data connection.
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method EnsureConnected Determines whether the current data connection is connected, and, if not, opens it.
Public method 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.
Public method GetLockedProviderObject() Retrieves the underlying locked data provider that supports the current data connection.
Public method GetLockedProviderObject(Int32) Retrieves the underlying data provider after locking the current data connection.
Public method GetService Gets the service object of the specified type. (Inherited from IServiceProvider.)
Public method Lock() Locks the current data connection.
Public method Lock(Int32) Locks the current data connection.
Public method Open Opens the current data connection.
Public method ReleaseExclusiveAccessProxy Releases an existing exclusive access proxy.
Public method Unlock Unlocks the current data connection.
Public method UnlockProviderObject Unlocks the underlying provider object for the current data connection.

Top

Events

  Name Description
Public event MessageReceived Occurs when a message is received from the data source. (Inherited from IVsDataConnectionEvents.)
Public event 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.

See Also

Reference

Microsoft.VisualStudio.Data.Services Namespace