FormsAuthenticationUserCollection.Remove(String) 方法

定義

命名空間:

System.Web.Configuration

組件:

System.Web.dll

從集合中移除 FormsAuthenticationUser 物件。

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

public void Remove (string name);

member this.Remove : string -> unit

Public Sub Remove (name As String)

參數

name

String

要從集合移除之 FormsAuthenticationUser 物件的名稱。

例外狀況

ConfigurationException

集合中沒有具備指定索引鍵的 FormsAuthenticationUser 物件，該項目可能已經移除，或者集合是唯讀的。

範例

下列程式碼範例示範如何使用 Remove 方法。

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

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

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

' Update if not locked
If Not authenticationSection.SectionInformation.IsLocked Then
   configuration.Save()
End If

備註

這個方法會將 remove 元素插入組態檔的適當區段中，以取得較高層級組態檔中定義的任何專案。 如果專案是在目前組態檔的適當區段中定義，則會從組態檔中移除其專案。 要移除的物件必須存在於集合中。