FormsAuthenticationUserCollection.Remove Method (String)

 

Removes a FormsAuthenticationUser object from the collection.

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

public void Remove(
	string name
)

Parameters

name
Type: System.String

The name of the FormsAuthenticationUser object to remove from the collection.

Exception Condition
ConfigurationException

There is no FormsAuthenticationUser object with the specified key in the collection, the element has already been removed, or the collection is read-only.

This method inserts a remove element into the appropriate section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the appropriate section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection.

The following code example shows how to use the Remove method.

// Using method Remove.
// Execute the Remove method.
formsAuthenticationCredentials.Users.Remove("userName");

// Update if not locked
if (!authenticationSection.SectionInformation.IsLocked)
{
    configuration.Save();
}

.NET Framework
Available since 2.0
Return to top
Show: