DataAsyncCommand.PrepareAsync Method

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.

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

Syntax

'Declaration
Public Sub PrepareAsync ( _
    command As String, _
    commandType As DataCommandType, _
    parameters As IVsDataParameter(), _
    commandTimeout As Integer, _
    userState As Object _
)

public void PrepareAsync(
    string command,
    DataCommandType commandType,
    IVsDataParameter[] parameters,
    int commandTimeout,
    Object userState
)

public:
virtual void PrepareAsync(
    String^ command, 
    DataCommandType commandType, 
    array<IVsDataParameter^>^ parameters, 
    int commandTimeout, 
    Object^ userState
) sealed

abstract PrepareAsync : 
        command:string * 
        commandType:DataCommandType * 
        parameters:IVsDataParameter[] * 
        commandTimeout:int * 
        userState:Object -> unit  
override PrepareAsync : 
        command:string * 
        commandType:DataCommandType * 
        parameters:IVsDataParameter[] * 
        commandTimeout:int * 
        userState:Object -> unit

public final function PrepareAsync(
    command : String, 
    commandType : DataCommandType, 
    parameters : IVsDataParameter[], 
    commandTimeout : int, 
    userState : Object
)

Parameters

• command
  Type: System.String

  The command to be prepared.

• commandType
  Type: Microsoft.VisualStudio.Data.Services.SupportEntities.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
  Type: array<Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]

  An array of IVsDataParameter objects as command parameters.

• commandTimeout
  Type: System.Int32

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

• userState
  Type: System.Object

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

Implements

IVsDataAsyncCommand.PrepareAsync(String, DataCommandType, array<IVsDataParameter[], Int32, Object)

Remarks

This method performs the same operation as the Prepare method, but in an asynchronous manner.

If the value of the commandTimeout parameter is 0, there is no timeout (or, timeout is infinite); if the value is -1, the timeout period is that set by the data provider.

The userState parameter uniquely identifies the specific asynchronous operation and is passed back as part of the event arguments for the DeriveParametersCompleted event so that a listener can determine which asynchronous process completed.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

DataAsyncCommand Class

Microsoft.VisualStudio.Data.Framework Namespace

DataCommand