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 ）。 以下条件适用。

  • EmitClear如果 设置为 true，clear则 元素将clientTarget插入到当前层次结构级别的配置文件的 节中。 这将删除对层次结构中 add 较高级别的父配置文件中定义的元素的所有引用。

  • 如果 标志 EmitClear 设置为 false，则会 clear 从 clientTarget 当前层次结构级别的配置文件的 节中删除元素（如果存在）。

方法 Clear 实际上删除在 add 当前层次结构级别的配置文件的 节中 clientTarget 定义的元素。 它还会删除对层次结构中较高级别的父配置文件中定义的 add 元素的所有引用。

注意

add不会从clientTarget父配置文件的 节中删除元素。