IVsDataCommand.Prepare Method (String, DataCommandType, array<IVsDataParameter , Int32)

When implemented by a class, prepares the specified command on the data source to be executed; the command may then be executed multiple times, with varying parameters.

Namespace:  Microsoft.VisualStudio.Data.Services.SupportEntities
Assembly:  Microsoft.VisualStudio.Data.Services (in Microsoft.VisualStudio.Data.Services.dll)

Syntax

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

string Prepare(
    string command,
    DataCommandType commandType,
    IVsDataParameter[] parameters,
    int commandTimeout
)

String^ Prepare(
    String^ command, 
    DataCommandType commandType, 
    array<IVsDataParameter^>^ parameters, 
    int commandTimeout
)

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

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

Parameters

• command
  Type: System.String

  A command to execute that is specific to a data source.

• commandType
  Type: Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType

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

• parameters
  Type: array<Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]

  An array of IVsDataParameter objects representing the command parameters.

• commandTimeout
  Type: System.Int32

  The length of time, in seconds, to block the client before canceling the execution and returning to the caller. A value of 0 indicates infinite time-out; a value of -1 indicates a provider default.

Return Value

Type: System.String
An identifier of the prepared command that you can later pass 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

IVsDataCommand Interface

Prepare Overload

Microsoft.VisualStudio.Data.Services.SupportEntities Namespace