IDictionary.Remove(Object) 方法

定义

命名空间:

System.Collections

程序集:

System.Runtime.dll

从 IDictionary 对象中移除具有指定键的元素。

public:
 void Remove(System::Object ^ key);

public void Remove (object key);

abstract member Remove : obj -> unit

Public Sub Remove (key As Object)

参数

key

Object

要移除的元素的键。

例外

ArgumentNullException

key 为 null。

NotSupportedException

IDictionary 对象是只读的。

- 或 -

IDictionary 具有固定的大小。

示例

下面的代码示例演示如何实现 Remove 方法。 此代码示例是为 IDictionary 类提供的一个更大示例的一部分。

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;
        }
    }

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.
    }
}

Public Sub Remove(ByVal key As Object) Implements IDictionary.Remove
    If key = Nothing Then
        Throw New ArgumentNullException("key")
    End If
    ' Try to find the key in the DictionaryEntry array
    Dim index As Integer
    If TryGetIndexOfKey(key, index) Then

        ' If the key is found, slide all the items up.
        Array.Copy(items, index + 1, items, index, (ItemsInUse - index) - 1)
        ItemsInUse = ItemsInUse - 1
    Else

        ' If the key is not in the dictionary, just return. 
    End If
End Sub

注解

如果 IDictionary 对象不包含具有指定键的元素，则 IDictionary 保持不变。 不会引发异常。