DataAsyncCommand Class

Definition

Enables executing data commands in an asynchronous manner.

public ref class DataAsyncCommand : Microsoft::VisualStudio::Data::Framework::DataSiteableObject<Microsoft::VisualStudio::Data::Services::IVsDataConnection ^>, Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataAsyncCommand
public class DataAsyncCommand : Microsoft.VisualStudio.Data.Framework.DataSiteableObject<Microsoft.VisualStudio.Data.Services.IVsDataConnection>, Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataAsyncCommand
type DataAsyncCommand = class
    inherit DataSiteableObject<IVsDataConnection>
    interface IVsDataAsyncCommand
Public Class DataAsyncCommand
Inherits DataSiteableObject(Of IVsDataConnection)
Implements IVsDataAsyncCommand
Inheritance
Implements

Constructors

DataAsyncCommand()

Creates a new instance of the DataAsyncCommand class.

DataAsyncCommand(IVsDataConnection)

Initializes a new instance of the DataAsyncCommand object with an IVsDataConnection object that is set on the inherited DataSiteableObject<T> object.

Properties

Site

Gets or sets the object site.

(Inherited from DataSiteableObject<T>)

Methods

CancelAsync(Object)

Cancels the asynchronous call, returning immediately.

DeriveParametersAsync(String, DataCommandType, Int32, Object)

Derives, in an asynchronous manner, a set of parameters for use with a specified command.

DeriveSchemaAsync(String, DataCommandType, IVsDataParameter[], Int32, Object)

Derives, in an asynchronous manner, the schema of the specified command.

ExecuteAsync(String, DataCommandType, IVsDataParameter[], Int32, Object)

Executes a command in an asynchronous manner.

ExecuteWithoutResultsAsync(String, DataCommandType, IVsDataParameter[], Int32, Object)

Executes, in an asynchronous manner, a command that does not return any results beyond an integer value indicating status.

OnCancel(Object)

Dispatches the asynchronous cancel operation to the appropriate synchronous method.

OnDeriveParameters(String, DataCommandType, Int32)

Dispatches the asynchronous derive parameters operation to the synchronous DeriveParameters(String, DataCommandType, Int32) method call.

OnDeriveParametersCompleted(DataAsyncCommandCompletedEventArgs<IVsDataParameter[]>)

Raises the DeriveParametersCompleted event.

OnDeriveSchema(String, DataCommandType, IVsDataParameter[], Int32)

Dispatches the asynchronous derive schema operation to the synchronous DeriveSchema(String, DataCommandType, IVsDataParameter[], Int32) method call.

OnDeriveSchemaCompleted(DataAsyncCommandCompletedEventArgs<IVsDataReader>)

Raises the DeriveSchemaCompleted event.

OnExecute(String, DataCommandType, IVsDataParameter[], Int32)

Dispatches the asynchronous execute operation to the synchronous Execute(String, DataCommandType, IVsDataParameter[], Int32) method call.

OnExecuteCompleted(DataAsyncCommandCompletedEventArgs<IVsDataReader>)

Raises the ExecuteCompleted event.

OnExecuteWithoutResults(String, DataCommandType, IVsDataParameter[], Int32)

Dispatches the asynchronous execute-without-results operation to the synchronous ExecuteWithoutResults(String, DataCommandType, IVsDataParameter[], Int32) method call.

OnExecuteWithoutResultsCompleted(DataAsyncCommandCompletedEventArgs<Int32>)

Raises the ExecuteWithoutResultsCompleted event.

OnPrepare(String, DataCommandType, IVsDataParameter[], Int32)

Dispatches the asynchronous prepare operation to the synchronous Prepare(String, DataCommandType, IVsDataParameter[], Int32) method call.

OnPrepareCompleted(DataAsyncCommandCompletedEventArgs<String>)

Raises the PrepareCompleted event.

OnSiteChanged(EventArgs)

Raises the SiteChanged event.

(Inherited from DataSiteableObject<T>)
PrepareAsync(String, DataCommandType, IVsDataParameter[], Int32, Object)

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.

Events

DeriveParametersCompleted

Occurs when the DeriveParametersAsync(String, DataCommandType, Int32, Object) command is completed.

DeriveSchemaCompleted

Occurs when the DeriveSchemaAsync(String, DataCommandType, IVsDataParameter[], Int32, Object) command is completed.

ExecuteCompleted

Occurs when the ExecuteAsync(String, DataCommandType, IVsDataParameter[], Int32, Object) command is completed.

ExecuteWithoutResultsCompleted

Occurs when the ExecuteWithoutResultsAsync(String, DataCommandType, IVsDataParameter[], Int32, Object) command is completed.

PrepareCompleted

Occurs when the PrepareAsync(String, DataCommandType, IVsDataParameter[], Int32, Object) command is completed.

SiteChanged

Occurs when the Site property is changed.

(Inherited from DataSiteableObject<T>)

Applies to