CustomErrorCollection.Remove Method (String)

 

Removes a CustomError object from the collection.

Namespace:   System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

public void Remove(
	string statusCode
)

Parameters

statusCode
Type: System.String

The HTTP status code associated with the custom error.

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.

System_CAPS_noteNote

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.

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();
}

.NET Framework
Available since 2.0
Return to top
Show: