CustomErrorCollection.Clear メソッド

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

CustomErrorCollection.Clear メソッド

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

コレクションからすべての CustomError オブジェクトを削除します。

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

Visual Basic (宣言)

Public Sub Clear

Visual Basic (使用法)

Dim instance As CustomErrorCollection

instance.Clear

C#

public void Clear ()

C++

public:
void Clear ()

J#

public void Clear ()

JScript

public function Clear ()

解説

Clear メソッドが呼び出された後の構成ファイルの更新結果は、選択された ConfigurationSaveMode によって異なります。構成ファイルを更新するには、Save か Save のいずれかのオーバーロードを使用します。

メモ
Save の呼び出しは、Save の呼び出しと等価です。

Save メソッドを使用する場合、次の条件が適用されます。

• Full または Modified のパラメータ値を渡した場合、clear 要素が現在の階層レベルの構成ファイルの clientTarget セクションに挿入されます。

• Minimal パラメータ値を渡した場合、一連の remove 要素が現在の階層レベルの構成ファイルの clientTarget 要素 (ASP.NET 設定スキーマ) に追加されます。これにより、上位階層レベルの親構成ファイルで定義されている add 要素へのすべての参照が削除されます。Minimal を使用すると、構成ファイルにシリアル化される対象に影響するプロパティ EmitClear がコレクションに追加されます。このプロパティは既定では false です。次の条件が適用されます。

  • EmitClear が true に設定されている場合、clear 要素が現在の階層レベルの構成ファイルの clientTarget セクションに挿入されます。これにより、上位階層レベルの親構成ファイルで定義されている add 要素へのすべての参照が削除されます。

  • EmitClear フラグが false に設定されていて、clear 要素が現在の階層レベルの構成ファイルの clientTarget セクションにある場合、この要素が削除されます。

Clear メソッドは、現在の階層レベルの構成ファイルの clientTarget セクションに定義されている add 要素を実際に削除します。このメソッドは、上位階層レベルの親構成ファイルで定義されている add 要素へのすべての参照も削除します。

メモ
親構成ファイルの clientTarget セクションにある add 要素は削除されません。

使用例

CustomErrorCollection コレクションからすべての CustomError オブジェクトを削除するコード例を次に示します。コレクションを取得する方法については、CustomErrorCollection クラスのトピックにあるコード例を参照してください。

Visual Basic

' Using the Clear method.
If Not customErrorsSection.SectionInformation.IsLocked
 Then
   ' Execute the Clear method.
   customErrorsCollection.Clear()
   configuration.Save()
End If

C#

// Using the Clear method.
if (!customErrorsSection.SectionInformation.IsLocked)
{
    // Execute the Clear method.
    customErrorsCollection.Clear();
    configuration.Save();
}

プラットフォーム

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

参照

関連項目
CustomErrorCollection クラス
CustomErrorCollection メンバ
System.Web.Configuration 名前空間
その他の技術情報
customErrors 要素 (ASP.NET 設定スキーマ)