DataCommand クラス

ビルド、さまざまな種類のデータ コマンドをデータ ソースに対して実行し、読み取り専用結果またはコマンドのステータス コードを取得する機能を提供します。

継承階層

System.Object
  Microsoft.VisualStudio.Data.Framework.DataSiteableObject<IVsDataConnection>
    Microsoft.VisualStudio.Data.Framework.DataCommand

名前空間:  Microsoft.VisualStudio.Data.Framework
アセンブリ:  Microsoft.VisualStudio.Data.Framework (Microsoft.VisualStudio.Data.Framework.dll 内)

構文

'宣言
Public MustInherit Class DataCommand _
    Inherits DataSiteableObject(Of IVsDataConnection) _
    Implements IVsDataCommand

public abstract class DataCommand : DataSiteableObject<IVsDataConnection>, 
    IVsDataCommand

public ref class DataCommand abstract : public DataSiteableObject<IVsDataConnection^>, 
    IVsDataCommand

[<AbstractClass>]
type DataCommand =  
    class
        inherit DataSiteableObject<IVsDataConnection>
        interface IVsDataCommand
    end

public abstract class DataCommand extends DataSiteableObject<IVsDataConnection> implements IVsDataCommand

DataCommand 型で公開されるメンバーは以下のとおりです。

コンストラクター

  名前 説明
プロテクト メソッド DataCommand() DataCommand クラスの新しいインスタンスを初期化します。
プロテクト メソッド DataCommand(IVsDataConnection) データ接続オブジェクトとともに DataCommand クラスの新しいインスタンスを初期化します。

このページのトップへ

プロパティ

  名前 説明
パブリック プロパティ Site オブジェクトのサイトを取得または設定します。 (DataSiteableObject<T> から継承されます。)

このページのトップへ

メソッド

  名前 説明
パブリック メソッド CreateParameter DataCommand のインスタンスの DeriveSchema、DeriveSchema、Execute、または ExecuteWithoutResults のメソッドに渡すことができるパラメーター オブジェクトを作成します。
パブリック メソッド DeriveParameters(String) 特定のコマンドに指定できるパラメーターを取得します。
パブリック メソッド DeriveParameters(String, DataCommandType) 特定のコマンドに指定できるパラメーターを取得します。
パブリック メソッド DeriveParameters(String, DataCommandType, Int32) 特定のコマンドに指定できるパラメーターを取得します。
パブリック メソッド DeriveSchema(String) 指定されたコマンドから返されるスキーマを取得します。スキーマは、データ リーダーの項目とブロックのレイアウトを示します。
パブリック メソッド DeriveSchema(String, DataCommandType) 指定されたコマンドから返されるスキーマを取得します。スキーマは、データ リーダーの項目とブロックのレイアウトを示します。
パブリック メソッド DeriveSchema(String, DataCommandType, array<IVsDataParameter[]) 指定されたコマンドから返されるスキーマを取得します。スキーマは、データ リーダーの項目とブロックのレイアウトを示します。
パブリック メソッド DeriveSchema(String, DataCommandType, array<IVsDataParameter[], Int32) 指定されたコマンドから返されるスキーマを取得します。スキーマは、データ リーダーの項目とブロックのレイアウトを示します。
パブリック メソッド Equals 指定のオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (Object から継承されます。)
パブリック メソッド Execute(String) 指定したコマンドを実行し、読み取り専用の結果を返します。
パブリック メソッド Execute(String, DataCommandType) 指定したコマンドを実行し、読み取り専用の結果を返します。
パブリック メソッド Execute(String, DataCommandType, array<IVsDataParameter[]) パラメーターで指定されたコマンドを、オプションで実行し、は読み取り専用になります。
パブリック メソッド Execute(String, DataCommandType, array<IVsDataParameter[], Int32) パラメーターで指定されたコマンドを、オプションで実行し、は読み取り専用になります。
パブリック メソッド ExecuteWithoutResults(String) 代わりにコマンドを実行し、結果を要求したり、呼び出しの結果を示す整数を返します。
パブリック メソッド ExecuteWithoutResults(String, DataCommandType) 代わりにコマンドを実行し、結果を要求したり、呼び出しの結果を示す整数を返します。
パブリック メソッド ExecuteWithoutResults(String, DataCommandType, array<IVsDataParameter[]) 代わりに、パラメーターのコマンドを、オプションで実行し、結果を要求したり、呼び出しの結果を示す整数を返します。
パブリック メソッド ExecuteWithoutResults(String, DataCommandType, array<IVsDataParameter[], Int32) 代わりに、パラメーターのコマンドを、オプションで実行し、結果を要求したり、呼び出しの結果を示す整数を返します。
プロテクト メソッド Finalize オブジェクトがガベージ コレクションにより収集される前に、そのオブジェクトがリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
パブリック メソッド GetHashCode 特定の型のハッシュ関数として機能します。 (Object から継承されます。)
パブリック メソッド GetType 現在のインスタンスの Type を取得します。 (Object から継承されます。)
プロテクト メソッド MemberwiseClone 現在の Object の簡易コピーを作成します。 (Object から継承されます。)
プロテクト メソッド OnSiteChanged SiteChanged イベントを発生させます。 (DataSiteableObject<T> から継承されます。)
パブリック メソッド Prepare(String) 実装されるデータ ソースで指定されたコマンドを準備します; コマンドは、複数回さまざまなパラメーターの実行できます。
パブリック メソッド Prepare(String, DataCommandType) 実装されるデータ ソースで指定されたコマンドを準備します; コマンドは、複数回さまざまなパラメーターの実行できます。
パブリック メソッド Prepare(String, DataCommandType, array<IVsDataParameter[]) 実装されるデータ ソースで指定されたコマンドを準備します; コマンドは、複数回さまざまなパラメーターの実行できます。
パブリック メソッド Prepare(String, DataCommandType, array<IVsDataParameter[], Int32) 実装されるデータ ソースで指定されたコマンドを準備します; コマンドは、複数回さまざまなパラメーターの実行できます。
パブリック メソッド ToString 現在のオブジェクトを表す文字列を返します。 (Object から継承されます。)

このページのトップへ

イベント

  名前 説明
パブリック イベント SiteChanged Site プロパティが変更されると発生します。 (DataSiteableObject<T> から継承されます。)

このページのトップへ

解説

データの Designer Extensibility (DDEX) のプロバイダーは、データ ソースに対してコマンドのさまざまな型を使用できます。これは、プロシージャ、および関数呼び出しなど、SQL ステートメントに限定される場合もあります。これらは、コマンドのパラメーターとスキーマを準備し、から派生する機能を公開する場合があります。

DataCommand のクラスは、コマンドの型が導入されています。コマンドの型が特定のコマンド文字列をプログラムによる解釈を示します。たとえば、コマンドの種類のテキストは、コマンド文字列が直接実行される SQL ステートメントです。DDEX のプロバイダーに通知する場合があります。また、TabularFunction のコマンドの型は、コマンド文字列が適切なメソッドを使用して実行されるテーブル値関数名であること DDEX のプロバイダーに通知する場合があります。

使用できるコマンド型の、通常はプレーンテキストとして、テーブルのフォームで、ストアド プロシージャとして設定を列挙する ODBC (Open Database Connectivity)、OLE DB と ADO.NET のしようとするなどの基になるテクノロジ。DataCommand のクラスは、このようなコマンドの型が固定列挙型に発生条件の弛緩に、この概念を拡張します。これによって追加するに DDEX プロバイダーを有効にできます。コマンドが使用できるとタイミングについての柔軟性とともにカスタム コマンドの型を提供します。

[!メモ]

コマンド実行機能を非同期的に指定するには、DataAsyncCommand のクラスを使用します。このクラスに DataCommand のクラスと同じですが、これらのメソッドは非同期で動作する一連のメソッドがあります。

継承時の注意

DataCommand のクラスから継承する場合、DDEX プロバイダーの実装でサポートされるこのクラスの各メソッドをオーバーライドする必要があります。このクラスの各メソッドの基本実装では、NotSupportedExceptionをスローします。

ExecuteWithoutResults のメソッドに Execute のメソッドへのデリゲート、その基本実装があることに注意してください。

スレッド セーフ

この型のすべてのパブリック static (Visual Basic では Shared) メンバーは、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。

参照

関連項目

Microsoft.VisualStudio.Data.Framework 名前空間

DataCommandType

  • Last updated on