FormsAuthenticationUserCollection.RemoveAt Method (Int32)

 

Removes a FormsAuthenticationUser object at the specified index from the collection.

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

Public Sub RemoveAt (
	index As Integer
)

Parameters

index
Type: System.Int32

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

Exception Condition
ConfigurationException

There is no FormsAuthenticationUser object at the specified index 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 RemoveAt.
formsAuthenticationCredentials.Users.RemoveAt(0)

If Not authenticationSection.SectionInformation.IsLocked Then
   configuration.Save()
End If

.NET Framework
Available since 2.0
Return to top
Show: