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

定義

オーバーロード

Remove(TKey)

指定したキーを持つ値を Dictionary<TKey,TValue> から削除します。Removes the value with the specified key from the Dictionary<TKey,TValue>.

Remove(TKey, TValue)

Remove(TKey)

指定したキーを持つ値を Dictionary<TKey,TValue> から削除します。Removes the value with the specified key from the 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

削除する要素のキー。The key of the element to remove.

戻り値

要素が見つかり、正常に削除された場合は true。それ以外の場合は falsetrue if the element is successfully found and removed; otherwise, false. このメソッドは、falsekey に見つからない場合、Dictionary<TKey,TValue> を返します。This method returns false if key is not found in the Dictionary<TKey,TValue>.

実装

例外

keynull です。key is null.

次のコード例は、Remove メソッドを使用してディクショナリからキーと値のペアを削除する方法を示しています。The following code example shows how to remove a key/value pair from a dictionary using the Remove method.

このコード例は、Dictionary<TKey,TValue> クラス用に用意されている大規模な例の一部です (openWith は、この例で使用されるディクショナリの名前です)。This code example is part of a larger example provided for the Dictionary<TKey,TValue> class (openWith is the name of the Dictionary used in this example).

// 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> は変更されません。If the Dictionary<TKey,TValue> does not contain an element with the specified key, the Dictionary<TKey,TValue> remains unchanged. 例外をスローすることはありません。No exception is thrown.

このメソッドは、O (1) 操作にアプローチします。This method approaches an O(1) operation.

.NET Core 3.0 以降のみ: この変更メソッドは、Dictionary<TKey,TValue> インスタンスでアクティブな列挙子を無効にせずに安全に呼び出すことができます。.NET Core 3.0+ only: this mutating method may be safely called without invalidating active enumerators on the Dictionary<TKey,TValue> instance. これは、スレッドの安全性を意味するものではありません。This does not imply thread safety.

こちらもご覧ください

Remove(TKey, TValue)

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

戻り値

適用対象