CustomErrorCollection.Clear メソッド

定義

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

public:
 void Clear();
public void Clear();
member this.Clear : unit -> unit
Public Sub Clear ()

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

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

注釈

Clear メソッドの呼び出し後に構成ファイルを更新した結果は、選択したConfigurationSaveModeに依存します。 構成ファイルを更新するには、 SaveSaveの 2 つのオーバーロードのいずれかを使用します。

Note

Save の呼び出しは、Save の呼び出しに相当します。

Save.method を使用する場合は、次の条件が適用されます。

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

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

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

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

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

Note

add要素は、親構成ファイルの clientTarget セクションから削除されません。

適用対象