DataCommand Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Data.Framework

Assembly:: Microsoft.VisualStudio.Data.Framework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides the ability to build and execute data commands of various types against data sources, and to retrieve read-only results or a command status code.

public ref class DataCommand abstract : Microsoft::VisualStudio::Data::Framework::DataSiteableObject<Microsoft::VisualStudio::Data::Services::IVsDataConnection ^>, Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataCommand

public abstract class DataCommand : Microsoft.VisualStudio.Data.Framework.DataSiteableObject<Microsoft.VisualStudio.Data.Services.IVsDataConnection>, Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataCommand

type DataCommand = class
    inherit DataSiteableObject<IVsDataConnection>
    interface IVsDataCommand

Public MustInherit Class DataCommand
Inherits DataSiteableObject(Of IVsDataConnection)
Implements IVsDataCommand

Inheritance: Object

DataSiteableObject<IVsDataConnection>
DataCommand

Implements: IVsDataCommand

Constructors

DataCommand()	Initializes a new instance of the DataCommand class.
DataCommand(IVsDataConnection)	Initializes a new instance of the DataCommand class together with a data connection object.

Properties

Site	Gets or sets the object site. (Inherited from DataSiteableObject<T>)

Methods

CreateParameter()	Creates a parameter object that can be passed into the DeriveSchema(String, Int32, DataParameter[], Int32), DeriveSchema(String, Int32, DataParameter[], Int32), Execute(String, Int32, DataParameter[], Int32), or ExecuteWithoutResults(String, DataCommandType, IVsDataParameter[]) methods on a DataCommand instance.
DeriveParameters(String)	Derives the parameters that can be specified for a given command.
DeriveParameters(String, DataCommandType)	Derives the parameters that can be specified for a given command.
DeriveParameters(String, DataCommandType, Int32)	Derives the parameters that can be specified for a given command.
DeriveSchema(String)	Derives the schema returned from a specified command. The schema indicates the layout of items and blocks in a data reader.
DeriveSchema(String, DataCommandType)	Derives the schema returned from a specified command. The schema indicates the layout of items and blocks in a data reader.
DeriveSchema(String, DataCommandType, IVsDataParameter[])	Derives the schema returned from a specified command. The schema indicates the layout of items and blocks in a data reader.
DeriveSchema(String, DataCommandType, IVsDataParameter[], Int32)	Derives the schema returned from a specified command. The schema indicates the layout of items and blocks in a data reader.
Execute(String)	Executes a specified command and returns read-only results.
Execute(String, DataCommandType)	Executes a specified command and returns read-only results.
Execute(String, DataCommandType, IVsDataParameter[])	Executes a specified command, optionally with parameters, and returns read-only results.
Execute(String, DataCommandType, IVsDataParameter[], Int32)	Executes a specified command, optionally with parameters, and returns read-only results.
ExecuteWithoutResults(String)	Executes a command but does not request results, instead returning an integer indicating the outcome of the call.
ExecuteWithoutResults(String, DataCommandType)	Executes a command but does not request results, instead returning an integer indicating the outcome of the call.
ExecuteWithoutResults(String, DataCommandType, IVsDataParameter[])	Executes a command, optionally with parameters, but does not request results, instead returning an integer indicating the outcome of the call.
ExecuteWithoutResults(String, DataCommandType, IVsDataParameter[], Int32)	Executes a command, optionally with parameters, but does not request results, instead returning an integer indicating the outcome of the call.
OnSiteChanged(EventArgs)	Raises the SiteChanged event. (Inherited from DataSiteableObject<T>)
Prepare(String)	Prepares the specified command on the data source to be executed; the command can then be executed multiple times, with varying parameters.
Prepare(String, DataCommandType)	Prepares the specified command on the data source to be executed; the command can then be executed multiple times, with varying parameters.
Prepare(String, DataCommandType, IVsDataParameter[])	Prepares the specified command on the data source to be executed; the command can then be executed multiple times, with varying parameters.
Prepare(String, DataCommandType, IVsDataParameter[], Int32)	Prepares the specified command on the data source to be executed; the command can then be executed multiple times, with varying parameters.

Events

SiteChanged

Occurs when the Site property is changed.

(Inherited from DataSiteableObject<T>)

Applies to