DataAsyncCommand Class

Enables executing data commands in an asynchronous manner.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.Framework.DataSiteableObject<IVsDataConnection>
    Microsoft.VisualStudio.Data.Framework.DataAsyncCommand

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

Syntax

'Declaration
Public Class DataAsyncCommand _
    Inherits DataSiteableObject(Of IVsDataConnection) _
    Implements IVsDataAsyncCommand
public class DataAsyncCommand : DataSiteableObject<IVsDataConnection>, 
    IVsDataAsyncCommand
public ref class DataAsyncCommand : public DataSiteableObject<IVsDataConnection^>, 
    IVsDataAsyncCommand
type DataAsyncCommand =  
    class 
        inherit DataSiteableObject<IVsDataConnection>
        interface IVsDataAsyncCommand 
    end
public class DataAsyncCommand extends DataSiteableObject<IVsDataConnection> implements IVsDataAsyncCommand

The DataAsyncCommand type exposes the following members.

Constructors

  Name Description
Protected method DataAsyncCommand() Creates a new instance of the DataAsyncCommand class.
Public method DataAsyncCommand(IVsDataConnection) Initializes a new instance of the DataAsyncCommand object with an IVsDataConnection object that is set on the inherited DataSiteableObject<T> object.

Top

Properties

  Name Description
Public property Site Gets or sets the object site. (Inherited from DataSiteableObject<T>.)

Top

Methods

  Name Description
Public method CancelAsync Cancels the asynchronous call, returning immediately.
Public method DeriveParametersAsync Derives, in an asynchronous manner, a set of parameters for use with a specified command.
Public method DeriveSchemaAsync Derives, in an asynchronous manner, the schema of the specified command.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method ExecuteAsync Executes a command in an asynchronous manner.
Public method ExecuteWithoutResultsAsync Executes, in an asynchronous manner, a command that does not return any results beyond an integer value indicating status.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnCancel Dispatches the asynchronous cancel operation to the appropriate synchronous method.
Protected method OnDeriveParameters Dispatches the asynchronous derive parameters operation to the synchronous DeriveParameters method call.
Protected method OnDeriveParametersCompleted Raises the DeriveParametersCompleted event.
Protected method OnDeriveSchema Dispatches the asynchronous derive schema operation to the synchronous DeriveSchema method call.
Protected method OnDeriveSchemaCompleted Raises the DeriveSchemaCompleted event.
Protected method OnExecute Dispatches the asynchronous execute operation to the synchronous Execute method call.
Protected method OnExecuteCompleted Raises the ExecuteCompleted event.
Protected method OnExecuteWithoutResults Dispatches the asynchronous execute-without-results operation to the synchronous ExecuteWithoutResults method call.
Protected method OnExecuteWithoutResultsCompleted Raises the ExecuteWithoutResultsCompleted event.
Protected method OnPrepare Dispatches the asynchronous prepare operation to the synchronous Prepare method call.
Protected method OnPrepareCompleted Raises the PrepareCompleted event.
Protected method OnSiteChanged Raises the SiteChanged event. (Inherited from DataSiteableObject<T>.)
Public method PrepareAsync Prepares, in an asynchronous manner, the specified command to be executed against the data source; the command may then be executed multiple times, with varying parameters.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event DeriveParametersCompleted Occurs when the DeriveParametersAsync command is completed.
Public event DeriveSchemaCompleted Occurs when the DeriveSchemaAsync command is completed.
Public event ExecuteCompleted Occurs when the ExecuteAsync command is completed.
Public event ExecuteWithoutResultsCompleted Occurs when the ExecuteWithoutResultsAsync command is completed.
Public event PrepareCompleted Occurs when the PrepareAsync command is completed.
Public event SiteChanged Occurs when the Site property is changed. (Inherited from DataSiteableObject<T>.)

Top

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

Microsoft.VisualStudio.Data.Framework Namespace