CustomErrorCollection.Clear 方法

定義

命名空間:

System.Web.Configuration

組件:

System.Web.dll

從集合中移除所有 CustomError 物件。

public:
 void Clear();

public void Clear ();

member this.Clear : unit -> unit

Public Sub Clear ()

範例

下列程式代碼範例會移除CustomErrorCollection集合中的所有 CustomError 物件。 請參閱類別主題中的 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 所選擇的 。 若要更新組態檔，您可以使用這兩個多載的其中一個： Save 和 Save。

注意

呼叫 Save 就相當於呼叫 Save。

如果您使用 Save.method，則適用下列條件。

• 如果您傳遞 Full 或 Modified 參數值，則會 clear 將元素插入 clientTarget 組態檔的 目前階層層級的 區段中。

• 如果您傳遞 Minimal 參數值，則會將一系列 remove 元素新增至 clientTarget 元素 (ASP.NET 設定架構) 目前階層層級的組態檔。 每個都會移除階層中較高層級上父組態檔中定義之專案的所有參考 add 。 當您使用 Minimal時，集合上有一個額外的屬性會影響串行化至組態檔的專案： EmitClear，預設為 false 。 適用條件如下。

  • 如果 設定為 EmitCleartrue， clear 專案就會 clientTarget 插入組態檔目前階層層級的 區段中。 這會移除階層中較高層級上父組態檔中定義之專案的所有參考 add 。

  • EmitClear如果旗標設定false為 ，clear則會從clientTarget目前階層層級組態檔的 區段中移除專案，如果存在的話。

方法 Clear 實際上會刪除 add 目前階層層級組態檔區段中定義的 clientTarget 專案。 它也會移除階層中較高層級上父組態檔中定義之 add 元素的所有參考。

注意

元素 add 不會從 clientTarget 父組態檔的 區段中刪除。