PersonalizationDictionary::Remove Method (String^)
.NET Framework (current version)
Removes a custom state entry based on the provided key.
Assembly: System.Web (in System.Web.dll)
Parameters
- key
-
Type:
System::String^
The key of the entry to be removed.
| Exception | Condition |
|---|---|
| ArgumentNullException | key is null. |
| 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
Available since 2.0
Available since 2.0
Show: