PersonalizationDictionary.Remove(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Removes a custom state entry based on the provided key.
public:
virtual void Remove(System::String ^ key);
public virtual void Remove (string key);
abstract member Remove : string -> unit
override this.Remove : string -> unit
Public Overridable Sub Remove (key As String)
Parameters
- key
- String
The key of the entry to be removed.
Exceptions
key
is null
.
key
is either an empty string (""), or trimming key
results in an empty string.
Remarks
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.