IDictionary.ContainsKey メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

IDictionary.ContainsKey メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Collections.Generic
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Function ContainsKey ( _
    key As TKey _
) As Boolean

Visual Basic (使用法)

Dim instance As IDictionary(Of
 TKey, TValue)
Dim key As TKey
Dim returnValue As Boolean

returnValue = instance.ContainsKey(key)

bool ContainsKey (
    TKey key
)

C++

bool ContainsKey (
    TKey key
)

boolean ContainsKey (
    TKey key
)

JScript

function ContainsKey (
    key : TKey
) : boolean

パラメータ

key: IDictionary 内で検索されるキー。

戻り値
指定したキーを持つ要素を IDictionary が保持している場合は true。それ以外の場合は false。

例外

例外の種類	条件
ArgumentNullException	key が null 参照 (Visual Basic では Nothing) です。

解説

オブジェクトが等しいかどうかを判断する方法で実装が異なります。たとえば、List クラスでは Comparer.Default が使用されます。また、Dictionary クラスでは、IComparer 実装をキーの比較に使うかどうかをユーザーが指定できます。

key を null 参照 (Visual Basic では Nothing) にできるかどうかは、実装によって異なります。

使用例

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

このコードは、コンパイルして実行することのできる例の一部です。詳細については、System.Collections.Generic.IDictionary のトピックを参照してください。

Visual Basic

        ' 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
<br /><span space="preserve">...</span><br
 />        ' 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
<br /><span space="preserve">...</span><br
 />        ' 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

        // 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"]);
        }
<br /><span space="preserve">...</span><br /> 
       // 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.");
        }
<br /><span space="preserve">...</span><br /> 
       // 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.");
        }