CustomErrorCollection.Remove(String) Method

Definition

Namespace:

System.Web.Configuration

Assembly:

System.Web.dll

Removes a CustomError object from the collection.

public:
 void Remove(System::String ^ statusCode);

public void Remove (string statusCode);

member this.Remove : string -> unit

Public Sub Remove (statusCode As String)

Parameters

statusCode

String

The HTTP status code associated with the custom error.

Examples

The following code example shows how to remove the CustomError object with the specified status code. Refer to the code example in the CustomErrorCollection class topic to learn how to get the collection.

// Using the Remove method.
if (!customErrorsSection.SectionInformation.IsLocked)
{
    // Remove the error with statuscode 404.
    customErrorsCollection.Remove("404");
    configuration.Save();
}

' Using the Remove method.
If Not customErrorsSection.SectionInformation.IsLocked Then
   ' Remove the error with statuscode 404.
   customErrorsCollection.Remove("404")
   configuration.Save()
End If

Remarks

The Remove method inserts a remove element into the customErrors section of the configuration file at the current hierarchy level. This removes the reference to the add element defined in the parent configuration files at higher levels in the hierarchy.

Note

The add elements are not deleted from the parent configuration files. The remove element merely deactivates them. However, the Remove method does actually delete them at the current hierarchy level.