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

定義

名前空間:

System.Collections.Generic

アセンブリ:

System.Runtime.dll

アセンブリ:

mscorlib.dll

アセンブリ:

netstandard.dll

指定したキーの要素が IDictionary<TKey,TValue> に格納されているかどうかを確認します。

public:
 bool ContainsKey(TKey key);

public bool ContainsKey (TKey key);

abstract member ContainsKey : 'Key -> bool

Public Function ContainsKey (key As TKey) As Boolean

パラメーター

key

TKey

IDictionary<TKey,TValue> 内で検索されるキー。

戻り値

Boolean

指定したキーを持つ要素を true が保持している場合は IDictionary<TKey,TValue>。それ以外の場合は false。

例外

ArgumentNullException

key が nullです。

例

次のコード例は、メソッドを使用して、メソッドを ContainsKey 呼び出す前にキーが存在するかどうかをテストする方法を Add 示しています。 また、このメソッドを TryGetValue 使用する方法も示します。これは、プログラムがディクショナリにないキー値を頻繁に試行する場合に、より効率的に値を取得する方法です。 最後に、プロパティ (C# のインデクサー) を使用して Item[] 項目を挿入する方法を示します。

このコードは、コンパイルおよび実行できるより大きな例の一部です。 以下を参照してください。System.Collections.Generic.IDictionary<TKey,TValue>

// ContainsKey can be used to test keys before inserting
// them.
if (!openWith->ContainsKey("ht"))
{
    openWith->Add("ht", "hypertrm.exe");
    Console::WriteLine("Value added for key = \"ht\": {0}",
        openWith["ht"]);
}

// ContainsKey can be used to test keys before inserting
// them.
if (!openWith.ContainsKey("ht"))
{
    openWith.Add("ht", "hypertrm.exe");
    Console.WriteLine("Value added for key = \"ht\": {0}",
        openWith["ht"]);
}

' ContainsKey can be used to test keys before inserting 
' them.
If Not openWith.ContainsKey("ht") Then
    openWith.Add("ht", "hypertrm.exe")
    Console.WriteLine("Value added for key = ""ht"": {0}", _
        openWith("ht"))
End If

// When a program often has to try keys that turn out not to
// be in the dictionary, TryGetValue can be a more efficient
// way to retrieve values.
String^ value = "";
if (openWith->TryGetValue("tif", value))
{
    Console::WriteLine("For key = \"tif\", value = {0}.", value);
}
else
{
    Console::WriteLine("Key = \"tif\" is not found.");
}

// When a program often has to try keys that turn out not to
// be in the dictionary, TryGetValue can be a more efficient
// way to retrieve values.
string value = "";
if (openWith.TryGetValue("tif", out value))
{
    Console.WriteLine("For key = \"tif\", value = {0}.", value);
}
else
{
    Console.WriteLine("Key = \"tif\" is not found.");
}

' When a program often has to try keys that turn out not to
' be in the dictionary, TryGetValue can be a more efficient 
' way to retrieve values.
Dim value As String = ""
If openWith.TryGetValue("tif", value) Then
    Console.WriteLine("For key = ""tif"", value = {0}.", value)
Else
    Console.WriteLine("Key = ""tif"" is not found.")
End If

// The indexer throws an exception if the requested key is
// not in the dictionary.
try
{
    Console::WriteLine("For key = \"tif\", value = {0}.",
        openWith["tif"]);
}
catch (KeyNotFoundException^)
{
    Console::WriteLine("Key = \"tif\" is not found.");
}

// The indexer throws an exception if the requested key is
// not in the dictionary.
try
{
    Console.WriteLine("For key = \"tif\", value = {0}.",
        openWith["tif"]);
}
catch (KeyNotFoundException)
{
    Console.WriteLine("Key = \"tif\" is not found.");
}

' The default Item property throws an exception if the requested
' key is not in the dictionary.
Try
    Console.WriteLine("For key = ""tif"", value = {0}.", _
        openWith("tif"))
Catch 
    Console.WriteLine("Key = ""tif"" is not found.")
End Try

注釈

実装は、オブジェクトの等価性を決定する方法によって異なる場合があります。たとえば、クラスでは List<T> 、クラスを使用 Comparer<T>.Defaultしますが Dictionary<TKey,TValue> 、ユーザーはキーの比較に使用する実装を指定 IComparer<T> できます。

実装は、許可されているかどうかによって異なる場合 key があります null。