IDictionary<TKey,TValue>.Remove(TKey) 方法

定义

命名空间:

System.Collections.Generic

程序集:

System.Runtime.dll

从 IDictionary<TKey,TValue> 中移除包含指定键的元素。

public:
 bool Remove(TKey key);

public bool Remove (TKey key);

abstract member Remove : 'Key -> bool

Public Function Remove (key As TKey) As Boolean

参数

key

TKey

要移除的元素的键。

返回

Boolean

如果该元素已成功移除，则为 true；否则为 false。 如果在原始 false 中没有找到 key，此方法也会返回 IDictionary<TKey,TValue>。

例外

ArgumentNullException

key 为 null。

NotSupportedException

IDictionary<TKey,TValue> 为只读。

示例

下面的代码示例演示如何使用 Remove 方法从字典中删除键/值对。

此代码是可以编译和执行的较大示例的一部分。 请参阅 System.Collections.Generic.IDictionary<TKey,TValue>。

// Use the Remove method to remove a key/value pair.
Console::WriteLine("\nRemove(\"doc\")");
openWith->Remove("doc");

if (!openWith->ContainsKey("doc"))
{
    Console::WriteLine("Key \"doc\" is not found.");
}

// Use the Remove method to remove a key/value pair.
Console.WriteLine("\nRemove(\"doc\")");
openWith.Remove("doc");

if (!openWith.ContainsKey("doc"))
{
    Console.WriteLine("Key \"doc\" is not found.");
}

' Use the Remove method to remove a key/value pair.
Console.WriteLine(vbLf + "Remove(""doc"")")
openWith.Remove("doc")

If Not openWith.ContainsKey("doc") Then
    Console.WriteLine("Key ""doc"" is not found.")
End If

注解

实现在确定对象相等性的方式上可能有所不同;例如， List<T> 类使用 Comparer<T>.Default，而 Dictionary<TKey,TValue> 类允许用户指定 IComparer<T> 用于比较键的实现。

另请参阅

• IsReadOnly