IDictionary.Remove Method

July 28, 2014

Removes the element with the specified key from the IDictionary object.

Namespace:  System.Collections
Assembly:  mscorlib (in mscorlib.dll)

void Remove(
	Object key
)

Parameters

key
Type: System.Object
The key of the element to remove.

ExceptionCondition
ArgumentNullException

key is null.

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 void Remove(object key)
{
   if (key == null) throw new ArgumentNullException("key");
   // Try to find the key in the DictionaryEntry array
   Int32 index;
   if (TryGetIndexOfKey(key, out index))
   {
      // If the key is found, slide all the items up.
      Array.Copy(items, index + 1, items, index, ItemsInUse - index - 1);
      ItemsInUse--;
   }
   else
   {
      // If the key is not in the dictionary, just return. 
   }
}


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2014 Microsoft