DataConnectionSupport Class

Provides properties and methods that enable you to work directly with connections to a data source.

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

Syntax

Public MustInherit Class DataConnectionSupport _
    Inherits ServiceProviderWithSite _
    Implements IDisposable

Dim instance As DataConnectionSupport
public abstract class DataConnectionSupport : ServiceProviderWithSite, IDisposable
public ref class DataConnectionSupport abstract : public ServiceProviderWithSite, 
    IDisposable
public abstract class DataConnectionSupport extends ServiceProviderWithSite implements IDisposable

Remarks

The DataConnectionSupport class represents the data provider implementation to support a data connection. The DDEX architecture implements the DataConnection class by calling into a provider specific DataConnectionSupport implementation.

The properties and methods on this class provide basic functionality that allows the data provider to communicate with the data source, performing such tasks as opening and closing connections and retrieving connection state. A data provider can also expose more specialized services by overriding the GetServiceImpl method. These connection-related services are summarized following:

  • DataViewSupport: Provides a method for retrieving XML that describes data source specific views of data objects to be shown in the Visual Studio Server Explorer.

  • DataObjectSupport: Provides a method for retrieving XML that describes types of data objects supported by the data source and actions that can be performed on them.

  • DataObjectIdentifierResolver: Provides a method for resolving data object identifiers.

  • DataObjectIdentifierConverter: Provides methods for converting between string and array representations of data object identifiers.

  • DataObjectItemComparer: Provides methods for comparing data object identifier parts and property values.

  • DataCommand: Provides the ability to derive and execute various types of commands.

  • DataAsyncCommand: Enables executing data commands in an asynchronous manner.

  • DataTransaction: Provides the ability to begin, commit, and roll back transactions.

  • DataSourceVersionComparer: Provides a method for comparing two data-source-specific version strings.

  • DataSourceInformation: Provides a set of well-defined name-value pairs that describe the data source.

This class implements the IObjectWithSite interface, which allows DDEX to site a data provider's DataConnectionSupport implementation with the DataConnection object that is calling into it. This provides the implementation with context, as well as with a means for retrieving Visual Studio services.

Any derived class should implement the various abstract properties and methods to support their connection. A derived class should also override the protected GetServiceImplmethod to provide its connection services. When a state-change or message-received event occurs, a derived class should, where possible, call the protected RaiseStateChanged and RaiseMessageReceived methods, which the base class then passes on to the sited DataConnection object.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.ServiceProvider
    Microsoft.VisualStudio.Data.ServiceProviderWithSite
      Microsoft.VisualStudio.Data.DataConnectionSupport
        Microsoft.VisualStudio.Data.AdoDotNet.AdoDotNetConnectionSupport

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.

See Also

Reference

DataConnectionSupport Members

Microsoft.VisualStudio.Data Namespace

ServiceProviderWithSite

IDisposable