DataAsyncCommand.OnPrepare Method

Dispatches the asynchronous prepare operation to the synchronous Prepare method call.

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

Syntax

'Declaration
Protected Overridable Function OnPrepare ( _
    command As String, _
    commandType As DataCommandType, _
    parameters As IVsDataParameter(), _
    commandTimeout As Integer _
) As String

protected virtual string OnPrepare(
    string command,
    DataCommandType commandType,
    IVsDataParameter[] parameters,
    int commandTimeout
)

protected:
virtual String^ OnPrepare(
    String^ command, 
    DataCommandType commandType, 
    array<IVsDataParameter^>^ parameters, 
    int commandTimeout
)

abstract OnPrepare : 
        command:string * 
        commandType:DataCommandType * 
        parameters:IVsDataParameter[] * 
        commandTimeout:int -> string  
override OnPrepare : 
        command:string * 
        commandType:DataCommandType * 
        parameters:IVsDataParameter[] * 
        commandTimeout:int -> string

protected function OnPrepare(
    command : String, 
    commandType : DataCommandType, 
    parameters : IVsDataParameter[], 
    commandTimeout : int
) : String

Parameters

• command
  Type: System.String

  The command for which the schema is derived.

• 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[]

  A list of parameters to pass with the command.

• commandTimeout
  Type: System.Int32

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

Return Value

Type: System.String
An identifier of the prepared command that can later be passed to the Execute or ExecuteWithoutResults methods by using the command type Prepared.

.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