Dictionary<TKey,TValue>.Remove メソッド

定義

名前空間:

System.Collections.Generic

アセンブリ:

System.Collections.dll

オーバーロード

Remove(TKey)	指定したキーを持つ値を Dictionary<TKey,TValue> から削除します。
Remove(TKey, TValue)	指定されたキーを持つ値を Dictionary<TKey,TValue> から削除し、その要素を value パラメーターにコピーします。

Remove(TKey)

ソース:

Dictionary.cs

指定したキーを持つ値を Dictionary<TKey,TValue> から削除します。

public:
 virtual bool Remove(TKey key);

public bool Remove (TKey key);

abstract member Remove : 'Key -> bool
override this.Remove : 'Key -> bool

Public Function Remove (key As TKey) As Boolean

パラメーター

key

TKey

削除する要素のキー。

戻り値

Boolean

要素が見つかり、正常に削除された場合は true。それ以外の場合は false。 このメソッドは、key が Dictionary<TKey,TValue> に見つからない場合、false を返します。

実装

Remove(TKey)

例外

ArgumentNullException

key が nullです。

例

次のコード例は、 メソッドを使用してディクショナリからキーと値のペアを削除する方法を Remove 示しています。

このコード例は、 クラスに対して提供される大きな例の Dictionary<TKey,TValue> 一部です (openWith は、この例で使用される Dictionary の名前です)。

// 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

注釈

に Dictionary<TKey,TValue> 指定したキーを持つ要素が含まれていない場合、 Dictionary<TKey,TValue> は変更されません。 例外はスローされません。

このメソッドは O(1) 操作に近づく。

.NET Core 3.0 以降のみ: この変更メソッドは、インスタンスのアクティブな列挙子を無効にせずに安全に Dictionary<TKey,TValue> 呼び出される場合があります。 これはスレッド セーフを意味するものではありません。

こちらもご覧ください

• Add(TKey, TValue)
• Remove(TKey)

Remove(TKey, TValue)

ソース:

Dictionary.cs

指定されたキーを持つ値を Dictionary<TKey,TValue> から削除し、その要素を value パラメーターにコピーします。

public:
 bool Remove(TKey key, [Runtime::InteropServices::Out] TValue % value);

public bool Remove (TKey key, out TValue value);

member this.Remove : 'Key * 'Value -> bool

Public Function Remove (key As TKey, ByRef value As TValue) As Boolean

パラメーター

key

TKey

削除する要素のキー。

value

TValue

削除された要素。

戻り値

Boolean

要素が見つかり、正常に削除された場合は true。それ以外の場合は false。

例外

ArgumentNullException

key が nullです。