PersonalizationDictionary.Remove メソッド

.NET Framework クラス ライブラリ リファレンス

PersonalizationDictionary.Remove メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

指定したキーに基づいて、カスタム状態エントリを削除します。

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overridable Sub Remove
 ( _
    key As String _
)

Visual Basic (使用法)

Dim instance As PersonalizationDictionary
Dim key As String

instance.Remove(key)

C#

public virtual void Remove (
    string key
)

C++

public:
virtual void Remove (
    String^ key
)

J#

public void Remove (
    String key
)

JScript

public function Remove (
    key : String
)

パラメータ

key

削除するエントリのキー。

例外

例外の種類	条件
ArgumentNullException	key が null 参照 (Visual Basic では Nothing) です。
ArgumentException	key が空の文字列 ("") か、または key をトリムして空の文字列になったかのいずれかです。

解説

内部的には、カスタム状態エントリを削除すると、パーソナル化ディクショナリの数が 1 つデクリメントされます。現在ディクショナリに対してアクティブな列挙子は、無効にする必要があります。

存在しないキーを削除しようとしても、エラーは発生しません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
PersonalizationDictionary クラス
PersonalizationDictionary メンバ
System.Web.UI.WebControls.WebParts 名前空間