IDictionary<TKey,TValue>.Remove(TKey) メソッド

定義

名前空間:
System.Collections.Generic
アセンブリ:
mscorlib.dll, System.Runtime.dll
アセンブリ:
mscorlib.dll
アセンブリ:
System.Runtime.dll
アセンブリ:
netstandard.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。 このメソッドは、元のIDictionary<TKey,TValue>でkeyが見つからなかった場合にもfalseを返します。

例外

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(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> 実装をユーザーが指定できます。

適用対象

こちらもご覧ください