IVsDataCommand Interface

  • Article

Represents the interface that exposes methods for data command handling, including building and executing data commands of various types against data sources, retrieving read-only results, and retrieving a command status code.

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

Syntax

'Declaration
<DataClientObjectAttribute("44B66758-3C1C-40ce-BEE4-5DBDA7293387")> _
Public Interface IVsDataCommand

[DataClientObjectAttribute("44B66758-3C1C-40ce-BEE4-5DBDA7293387")]
public interface IVsDataCommand

[DataClientObjectAttribute(L"44B66758-3C1C-40ce-BEE4-5DBDA7293387")]
public interface class IVsDataCommand

[<DataClientObjectAttribute("44B66758-3C1C-40ce-BEE4-5DBDA7293387")>]
type IVsDataCommand =  interface end

public interface IVsDataCommand

The IVsDataCommand type exposes the following members.

Methods

  Name Description
Public method CreateParameter When implemented by a class, creates a parameter object that can be passed into one of the following methods: DeriveSchema, Execute, or ExecuteWithoutResults.
Public method DeriveParameters(String) When implemented by a class, derives the parameters that can be specified for a given command.
Public method DeriveParameters(String, DataCommandType) When implemented by a class, derives the parameters that can be specified for a given command.
Public method DeriveParameters(String, DataCommandType, Int32) When implemented by a class, derives the parameters that can be specified for a given command.
Public method DeriveSchema(String) When implemented by a class, derives the schema returned from a specified command. The schema indicates the layout of items and blocks in a data reader.
Public method DeriveSchema(String, DataCommandType) When implemented by a class, derives the schema returned from a specified command. The schema indicates the layout of items and blocks in a data reader.
Public method DeriveSchema(String, DataCommandType, array<IVsDataParameter[]) When implemented by a class, derives the schema returned from a specified command. The schema indicates the layout of items and blocks in a data reader.
Public method DeriveSchema(String, DataCommandType, array<IVsDataParameter[], Int32) When implemented by a class, derives the schema returned from a specified command. The schema indicates the layout of items and blocks in a data reader.
Public method Execute(String) When implemented by a class, executes a specified command and returns read-only results.
Public method Execute(String, DataCommandType) When implemented by a class, executes a specified command and returns read-only results.
Public method Execute(String, DataCommandType, array<IVsDataParameter[]) When implemented by a class, executes a specified command and returns read-only results.
Public method Execute(String, DataCommandType, array<IVsDataParameter[], Int32) When implemented by a class, executes a specified command and returns read-only results.
Public method ExecuteWithoutResults(String) When implemented by a class, executes a command but does not request results, instead returning an integer indicating the outcome of the call.
Public method ExecuteWithoutResults(String, DataCommandType) When implemented by a class, executes a command but does not request results, instead returning an integer indicating the outcome of the call.
Public method ExecuteWithoutResults(String, DataCommandType, array<IVsDataParameter[]) When implemented by a class, executes a command, optionally with parameters, but does not request results, instead returning an integer indicating the outcome of the call.
Public method ExecuteWithoutResults(String, DataCommandType, array<IVsDataParameter[], Int32) When implemented by a class, executes a command, optionally with parameters, but does not request results, instead returning an integer indicating the outcome of the call.
Public method 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 method 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 method Prepare(String, DataCommandType, array<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 method Prepare(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.

Top

Remarks

This interface has a base implementation in the DDEX Framework.

See Also

Reference

Microsoft.VisualStudio.Data.Services.SupportEntities Namespace