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 * 'Value -> bool
override this.TryGetValue : 'Key * 'Value -> 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> содержит элемент с указанным ключом, в противном случае — false.true 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 для типов Boolean и 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.

Применяется к

Дополнительно