Dictionary<TKey,TValue>.TryGetValue(TKey, TValue) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает значение, связанное с указанным ключом.
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
Ключ возвращаемого значения.
- value
- TValue
При возврате этого метода содержит значение, связанное с указанным ключом, если ключ найден; в противном случае значение по умолчанию для типа value параметра. Этот параметр передается неинициализирован.
Возвращаемое значение
true Значение , если элемент Dictionary<TKey,TValue> содержит элемент с указанным ключом; в противном случае false.
Реализации
Исключения
key равно null.
Примеры
В примере показано, как использовать TryGetValue метод в качестве более эффективного способа получения значений в программе, которая часто пытается использовать ключи, которые не находятся в словаре. В примере также показано, как Item[] свойство (индексатор в C#) создает исключения при попытке получить несуществующие ключи.
Этот пример кода является частью более крупного примера, предоставленного для Dictionary<TKey,TValue> класса (openWith это имя словаря, используемого в этом примере).
// 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.
match openWith.TryGetValue "tif" with
| true, value -> printfn $"For key = \"tif\", value = {value}."
| _ -> printfn "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
printfn $"""For key = "tif", value = {openWith["tif"]}"""
with :? KeyNotFoundException ->
printfn "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[] свойства.
Если ключ не найден, value параметр получает соответствующее значение по умолчанию для типа TValue; например, 0 (ноль) для целых типов, false для логических типов и null ссылочных типов.
Используйте метод, TryGetValue если код часто пытается получить доступ к ключам, которые не находятся в словаре. Использование этого метода является более эффективным, чем перехват вызываемого KeyNotFoundException свойством Item[] .
Этот метод подходит к операции O(1).