DataCommand.Prepare 方法 (String, DataCommandType, array<IVsDataParameter , Int32)

2012-10-25

准备在数据源中指定的命令执行;命令可然后执行多次，使用不同的参数。

命名空间： Microsoft.VisualStudio.Data.Framework
程序集： Microsoft.VisualStudio.Data.Framework（在 Microsoft.VisualStudio.Data.Framework.dll 中）

语法

声明
Public Overridable Function Prepare ( _
    command As String, _
    commandType As DataCommandType, _
    parameters As IVsDataParameter(), _
    commandTimeout As Integer _
) As String

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

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

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

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

参数

command
类型：System.String
特定于数据源的命令执行。

commandType
类型：Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType
指定如何解释 command 参数的内容命令的类型。命令类型可以是从 DataCommandType 枚举中的值或提供程序定义的自定义命令类型，可以通过强制从整数的转换传递给 DataCommandType 枚举。

parameters
类型：array<Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]
数组指示指定的命令 IVsDataParameter 对象命令的参数类型。

commandTimeout
类型：System.Int32
时间长度，秒，取消执行并返回之前阻止客户端调用方。值0表示无限超时;值-1表示一个提供默认值。

返回值

类型：System.String
使用命令类型 Prepared，稍后可传递给 Execute 或 ExecuteWithoutResults 方法准备的命令的标识符。

实现

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

异常

异常	条件
ArgumentNullException	command 参数为 nullnull 引用（在 Visual Basic 中为 Nothing）。
ArgumentOutOfRangeException	commandTimeout 参数小于 -1。