Edit

FormsAuthenticationUserCollection.Clear Method

  • Reference

Definition

Namespace:
System.Web.Configuration
Assembly:
System.Web.dll

Removes all FormsAuthenticationUser objects from the collection.

public:
 void Clear();
public void Clear ();
member this.Clear : unit -> unit
Public Sub Clear ()

Exceptions

ConfigurationException

The collection is read-only.

Examples

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

// Using method Clear.
formsAuthenticationCredentials.Users.Clear();
// Update if not locked
if (!authenticationSection.SectionInformation.IsLocked)
{
    configuration.Save();
}

' Using method Clear.
formsAuthenticationCredentials.Users.Clear()
' Update if not locked
If Not authenticationSection.SectionInformation.IsLocked Then
   configuration.Save()
End If

Remarks

This method inserts a clear directive into the appropriate section of the configuration file to clear all references to elements defined in a higher-level configuration file. All elements defined in the appropriate section of the current configuration file are removed.

Applies to