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

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

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

IDictionary.TryGetValue メソッド

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

指定したキーに関連付けられている値を取得します。

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

Visual Basic (宣言)

Function TryGetValue ( _
    key As TKey, _
    <OutAttribute> ByRef value As TValue
 _
) As Boolean

Visual Basic (使用法)

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

returnValue = instance.TryGetValue(key, value)

bool TryGetValue (
    TKey key,
    out TValue value
)

C++

bool TryGetValue (
    TKey key, 
    [OutAttribute] TValue% value
)

boolean TryGetValue (
    TKey key, 
    /** @attribute OutAttribute() */ /** @ref */ TValue value
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

key: 値を取得する対象のキー。

value: このメソッドが返されるときに、キーが見つかった場合は、指定したキーに関連付けられている値。それ以外の場合は value パラメータの型に対する既定の値。このパラメータは初期化せずに渡されます。

戻り値
指定したキーを持つ要素が IDictionary を実装するオブジェクトに格納されている場合は true。それ以外の場合は false。

例外

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

解説

このメソッドは、ContainsKey メソッドの機能と Item プロパティを組み合わせます。

キーが見つからない場合、value パラメータは、値型 V に対する適切な既定値 (整数型にはゼロ (0)、ブール型には false、参照型には null 参照 (Visual Basic では Nothing) など) を取得します。

使用例

この例では、TryGetValue メソッドを使用して値を取得する方法を示します。プログラムがディクショナリにないキー値を頻繁に試行する場合は、存在しないキーを取得しようとすると例外がスローされる Item プロパティ (C# の場合はインデクサ) よりも、TryGetValue メソッドを使用するほうが効率的です。

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

Visual Basic

        ' 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

        // 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.");
        }