SqlDataSourceView.ExecuteDelete メソッド

.NET Framework クラス ライブラリ リファレンス

SqlDataSourceView.ExecuteDelete メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

DeleteCommand SQL 文字列、DeleteParameters コレクションで指定した任意のパラメータ、および指定した keys コレクションと oldValues コレクション内の値を使用して、削除操作を実行します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Protected Overrides Function
 ExecuteDelete ( _
    keys As IDictionary, _
    oldValues As IDictionary _
) As Integer

Visual Basic (使用法)

Dim keys As IDictionary
Dim oldValues As IDictionary
Dim returnValue As Integer

returnValue = Me.ExecuteDelete(keys, oldValues)

C#

protected override int ExecuteDelete (
    IDictionary keys,
    IDictionary oldValues
)

C++

protected:
virtual int ExecuteDelete (
    IDictionary^ keys, 
    IDictionary^ oldValues
) override

J#

protected int ExecuteDelete (
    IDictionary keys, 
    IDictionary oldValues
)

JScript

protected override function ExecuteDelete (
    keys : IDictionary, 
    oldValues : IDictionary
) : int

パラメータ

keys

ExecuteDelete 操作で削除するオブジェクトまたは行のキー値の IDictionary。

oldValues

ConflictDetection プロパティが CompareAllValues 値に設定されている場合にだけ評価される行の値を格納している IDictionary。

戻り値
基になるデータベースから削除された行数を表す値。

例外

例外の種類	条件
InvalidOperationException	SqlDataSource が、基になるデータ ソースとの接続を確立できません。 または ConflictDetection プロパティが CompareAllValues 値に設定され、oldValues パラメータが渡されていません。
HttpException	現在のユーザーには、データベースにアクセスできる正しいアクセス許可がありません。 または コントロールのインスタンスは、AccessDataSource コントロールであり、DataFile プロパティに指定されているパスへのアクセスは拒否されます。
NotSupportedException	CanDelete プロパティが false です。 または AccessDataSource コントロールのインスタンスを使用する前に、デザイン時の相対パスがデザイナによって正しく割り当てられていませんでした。

解説

SqlDataSourceView クラスは、継承された ExecuteDelete メソッドを実装して、データベースからデータを削除します。ページ開発者およびデータ連結コントロールの作成者は、ExecuteDelete メソッドを直接呼び出す代わりに、パブリックとして公開された Delete メソッドを使用します。

keys コレクションに格納されている値が評価され、DeleteParameters コレクションに格納されている任意の値とマージされます。ConflictDetection プロパティが CompareAllValues 値に設定されている場合、oldValues コレクションに格納されている値が、OldValuesParameterFormatString プロパティで書式設定され、さらにマージされます。

削除操作を実行する前に、OnDeleting メソッドが呼び出されて Deleting イベントが発生します。このイベントを処理してパラメータの値を調べ、削除の前に処理を実行できます。

削除操作を実行するために、SqlDataSourceView オブジェクトは、DeleteCommand テキストおよび関連する任意の DeleteParameters プロパティを使用して DbCommand オブジェクトを構築し、基になるデータベースに対して DbCommand オブジェクトを実行します。削除操作が完了した後、OnDeleted メソッドが呼び出されて Deleted イベントが発生します。このイベントを処理することにより、戻り値とエラー コードを調べ、後処理を実行できます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SqlDataSourceView クラス
SqlDataSourceView メンバ
System.Web.UI.WebControls 名前空間
Delete
DeleteCommand
DeleteParameters