This documentation is archived and is not being maintained.

PersonalizationDictionary::Remove Method

Removes a custom state entry based on the provided key.

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public:
virtual void Remove(
	String^ key
)

Parameters

key
Type: System::String
The key of the entry to be removed.

ExceptionCondition
ArgumentNullException

key is nullptr.

ArgumentException

key is either an empty string (""), or trimming key results in an empty string.

Internally, when you remove a custom state entry, the count of the personalization dictionary is decremented by one. Any enumerators currently active against the dictionary should be invalidated.

No error occurs if you attempt to remove a nonexistent key.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: