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 上位レベルの構成ファイルで定義されている要素に対して、構成ファイルの適切なセクションに要素を挿入します。 要素が現在の構成ファイルの適切なセクションで定義されている場合、そのエントリは構成ファイルから削除されます。 削除するオブジェクトは、コレクション内に存在する必要があります。