IVsDataCommand.Prepare Method

Definition

Namespace:

Microsoft.VisualStudio.Data.Services.SupportEntities

Assembly:

Microsoft.VisualStudio.Data.Services.dll

Package:

Microsoft.VisualStudio.Data.Services v17.10.40170

Overloads

Prepare(String)	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.
Prepare(String, DataCommandType)	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.
Prepare(String, DataCommandType, IVsDataParameter[])	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.
Prepare(String, DataCommandType, 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.

Prepare(String)

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.

public:
 System::String ^ Prepare(System::String ^ command);

public string Prepare (string command);

abstract member Prepare : string -> string

Public Function Prepare (command As String) As String

Parameters

command

String

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

Returns

String

An identifier of the prepared command that you can later pass to the Execute(String, DataCommandType, IVsDataParameter[], Int32) or ExecuteWithoutResults(String, DataCommandType, IVsDataParameter[], Int32) methods by using the command type Prepared.

Prepare(String, DataCommandType)

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.

public:
 System::String ^ Prepare(System::String ^ command, Microsoft::VisualStudio::Data::Services::SupportEntities::DataCommandType commandType);

public string Prepare (string command, Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType commandType);

abstract member Prepare : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType -> string

Public Function Prepare (command As String, commandType As DataCommandType) As String

Parameters

command

String

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

commandType

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.

Returns

String

An identifier of the prepared command that you can later pass to the Execute(String, DataCommandType, IVsDataParameter[], Int32) or ExecuteWithoutResults(String, DataCommandType, IVsDataParameter[], Int32) methods by using the command type Prepared.

Prepare(String, DataCommandType, IVsDataParameter[])

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.

public:
 System::String ^ Prepare(System::String ^ command, Microsoft::VisualStudio::Data::Services::SupportEntities::DataCommandType commandType, cli::array <Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataParameter ^> ^ parameters);

public string Prepare (string command, Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType commandType, Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] parameters);

abstract member Prepare : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType * Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] -> string

Public Function Prepare (command As String, commandType As DataCommandType, parameters As IVsDataParameter()) As String

Parameters

command

String

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

commandType

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

IVsDataParameter[]

An array of IVsDataParameter objects representing the command parameters.

Returns

String

An identifier of the prepared command that you can later pass to the Execute(String, DataCommandType, IVsDataParameter[], Int32) or ExecuteWithoutResults(String, DataCommandType, IVsDataParameter[], Int32) methods by using the command type Prepared.

Prepare(String, DataCommandType, 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.

public:
 System::String ^ Prepare(System::String ^ command, Microsoft::VisualStudio::Data::Services::SupportEntities::DataCommandType commandType, cli::array <Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataParameter ^> ^ parameters, int commandTimeout);

public string Prepare (string command, Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType commandType, Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] parameters, int commandTimeout);

abstract member Prepare : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType * Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] * int -> string

Public Function Prepare (command As String, commandType As DataCommandType, parameters As IVsDataParameter(), commandTimeout As Integer) As String

Parameters

command

String

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

commandType

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

IVsDataParameter[]

An array of IVsDataParameter objects representing the command parameters.

commandTimeout

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.

Returns

String

An identifier of the prepared command that you can later pass to the Execute(String, DataCommandType, IVsDataParameter[], Int32) or ExecuteWithoutResults(String, DataCommandType, IVsDataParameter[], Int32) methods by using the command type Prepared.