Dictionary<TKey,TValue>.TryGetValue(TKey, TValue) Dictionary<TKey,TValue>.TryGetValue(TKey, TValue) Dictionary<TKey,TValue>.TryGetValue(TKey, TValue) Dictionary<TKey,TValue>.TryGetValue(TKey, TValue) Method

定義

指定したキーに関連付けられている値を取得します。Gets the value associated with the specified key.

public:
 virtual bool TryGetValue(TKey key, [Runtime::InteropServices::Out] TValue % value);
public bool TryGetValue (TKey key, out TValue value);
abstract member TryGetValue : 'Key *  -> bool
override this.TryGetValue : 'Key *  -> bool
Public Function TryGetValue (key As TKey, ByRef value As TValue) As Boolean

パラメーター

key
TKey TKey TKey TKey

取得する値のキー。The key of the value to get.

value
TValue TValue TValue TValue

このメソッドから制御が戻るときに、キーが見つかった場合は、指定したキーに関連付けられている値が格納されます。それ以外の場合は value パラメーターの型に対する既定の値です。When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. このパラメーターは初期化せずに渡されます。This parameter is passed uninitialized.

戻り値

指定したキーを持つ要素が true に格納されている場合は Dictionary<TKey,TValue>。それ以外の場合は falsetrue if the Dictionary<TKey,TValue> contains an element with the specified key; otherwise, false.

実装

例外

例では、使用する方法を示します、TryGetValueメソッドとして、ディクショナリにないキーを頻繁に試行するプログラムで値を取得するより効率的な方法です。The example shows how to use the TryGetValue method as a more efficient way to retrieve values in a program that frequently tries keys that are not in the dictionary. これに対しても示していますが、どのようにItem[TKey]プロパティ (c# のインデクサー) が存在しないキーを取得中に例外をスローします。For contrast, the example also shows how the Item[TKey] property (the indexer in C#) throws exceptions when attempting to retrieve nonexistent keys.

このコード例が示されている例の一部、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).

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

注釈

このメソッドには、機能が組み合わされて、ContainsKeyメソッドとItem[TKey]プロパティ。This method combines the functionality of the ContainsKey method and the Item[TKey] property.

キーが見つからない場合、valueパラメーター型の適切な既定値を取得するTValue; たとえば、整数型は、0 (ゼロ)falseブール型の場合とnull参照型。If the key is not found, then the value parameter gets the appropriate default value for the type TValue; for example, 0 (zero) for integer types, false for Boolean types, and null for reference types.

使用して、TryGetValueメソッドの場合は、ディクショナリにないキーにアクセスするコードを頻繁に試行します。Use the TryGetValue method if your code frequently attempts to access keys that are not in the dictionary. キャッチするよりも効率的ではこのメソッドを使用して、KeyNotFoundExceptionによってスローされた、Item[TKey]プロパティ。Using this method is more efficient than catching the KeyNotFoundException thrown by the Item[TKey] property.

このメソッドは、o (1) 操作に近くなります。This method approaches an O(1) operation.

適用対象

こちらもご覧ください