IDictionary.Remove 方法

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

**命名空间:**System.Collections
**程序集:**mscorlib（在 mscorlib.dll 中）

语法

声明
Sub Remove ( _
    key As Object _
)
用法
Dim instance As IDictionary
Dim key As Object

instance.Remove(key)

void Remove (
    Object key
)

void Remove (
    Object^ key
)

void Remove (
    Object key
)

function Remove (
    key : Object
)

参数

• key
  要移除的元素的键。

异常

异常类型	条件
ArgumentNullException	key 为 空引用（在 Visual Basic 中为 Nothing）。
NotSupportedException	IDictionary 对象为只读。 - 或 - IDictionary 具有固定大小。

备注

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

示例

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

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

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:
    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 98、Windows 2000 SP4、Windows CE、Windows Millennium Edition、Windows Mobile for Pocket PC、Windows Mobile for Smartphone、Windows Server 2003、Windows XP Media Center Edition、Windows XP Professional x64 Edition、Windows XP SP2、Windows XP Starter Edition

.NET Framework 并不是对每个平台的所有版本都提供支持。有关受支持版本的列表，请参见系统要求。

版本信息

.NET Framework

受以下版本支持：2.0、1.1、1.0

.NET Compact Framework

受以下版本支持：2.0、1.0

请参见

参考

IDictionary 接口
IDictionary 成员
System.Collections 命名空间