IDictionary::Remove Method
Removes the element with the specified key from the IDictionary object.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- key
- Type: System::Object
The key of the element to remove.
| Exception | Condition |
|---|---|
| ArgumentNullException | key is nullptr. |
| NotSupportedException | The IDictionary object is read-only. -or- The IDictionary has a fixed size. |
If the IDictionary object does not contain an element with the specified key, the IDictionary remains unchanged. No exception is thrown.
The following code example demonstrates how to implement the Remove method. This code example is part of a larger example provided for the IDictionary class.
public: virtual void Remove(Object^ key) { if (key == nullptr) { throw gcnew ArgumentNullException("key"); } // Try to find the key in the DictionaryEntry array int index; if (TryGetIndexOfKey(key, &index)) { // If the key is found, slide all the items down. Array::Copy(items, index + 1, items, index, itemsInUse - index - 1); itemsInUse--; } else { // If the key is not in the dictionary, just return. return; } }
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.