DataCommand クラス
ビルドされ、さまざまな型のデータ コマンドがデータ ソースに対して実行し、読み取り専用結果またはコマンド ステータス コードを取得する機能が用意されています。
継承階層
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 型で公開されるメンバーは以下のとおりです。
コンストラクター
| 名前 | 説明 | |
|---|---|---|
.gif "プロテクト メソッド") |
DataCommand() | DataCommand クラスの新しいインスタンスを初期化します。 |
|
DataCommand(IVsDataConnection) | データ接続オブジェクトとともに DataCommand クラスの新しいインスタンスを初期化します。 |
このページのトップへ
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
Site | オブジェクトのサイトを取得または設定します。 (DataSiteableObject<T> から継承されます。) |
このページのトップへ
メソッド
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック メソッド") |
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 から継承されます。) |
このページのトップへ
イベント
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック イベント") |
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) メンバーは、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。