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

定義

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

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

パラメーター

key
TKey TKey TKey TKey

値を取得する対象のキー。The key whose value to get.

value
TValue TValue TValue TValue

このメソッドが返されるときに、キーが見つかった場合は、指定したキーに関連付けられている値。それ以外の場合は value パラメーターの型に対する既定の値。When this method returns, 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.

戻り値

指定したキーを持つ要素が IDictionary<TKey,TValue> を実装するオブジェクトに格納されている場合は true、それ以外の場合は falsetrue if the object that implements IDictionary<TKey,TValue> contains an element with the specified key; otherwise, false.

例外

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

このコードは、コンパイルして実行できる大きな例の一部です。This code is part of a larger example that can be compiled and executed. 以下を参照してください。System.Collections.Generic.IDictionary<TKey,TValue>See System.Collections.Generic.IDictionary<TKey,TValue>.

// 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, zero (0) for integer types, false for Boolean types, and null for reference types.

適用対象

こちらもご覧ください