DataAsyncCommand.PrepareAsync Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Data.Framework
Assembly:
Microsoft.VisualStudio.Data.Framework.dll
Package:
Microsoft.VisualStudio.Data.Framework v17.10.40170

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:
 virtual void PrepareAsync(System::String ^ command, Microsoft::VisualStudio::Data::Services::SupportEntities::DataCommandType commandType, cli::array <Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataParameter ^> ^ parameters, int commandTimeout, System::Object ^ userState);
public void PrepareAsync (string command, Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType commandType, Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] parameters, int commandTimeout, object userState);
abstract member PrepareAsync : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType * Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] * int * obj -> unit
override this.PrepareAsync : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType * Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] * int * obj -> unit
Public Sub PrepareAsync (command As String, commandType As DataCommandType, parameters As IVsDataParameter(), commandTimeout As Integer, userState As Object)

Parameters

command
String

The command to be prepared.

commandType
DataCommandType

A value from the DataCommandType enumeration representing the command type for the indicated command. The value specifies how to interpret the contents of the command parameter.

parameters
IVsDataParameter[]

An array of IVsDataParameter objects as command parameters.

commandTimeout
Int32

Amount of time, in seconds, before which the command times out.

userState
Object

The object on which this method calls back as the command progresses.

Implements

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

Applies to