IDictionary<TKey,TValue>.TryGetValue(TKey, TValue) Метод

Определение

Получает значение, связанное с заданным ключом.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

Ключ, значение которого необходимо получить.The key whose value to get.

value
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.

Возвращаемое значение

Boolean

Значение true, если объект, реализующий IDictionary<TKey,TValue>, содержит элемент с указанным ключом, в противном случае — значение false.true if the object that implements IDictionary<TKey,TValue> contains an element with the specified key; otherwise, false.

Исключения

key имеет значение null.key is null.

Примеры

В примере показано, как использовать TryGetValue метод для извлечения значений.The example shows how to use the TryGetValue method to retrieve values. Если программа часто пытается использовать ключевые значения, которых нет в словаре, TryGetValue метод может оказаться более эффективным, чем использование Item[] Свойства (индексатор в 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[] 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[] Свойства.This method combines the functionality of the ContainsKey method and the Item[] 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, zero (0) for integer types, false for Boolean types, and null for reference types.

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

См. также раздел