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

Определение

Пространство имен:

System.Collections.Generic

Сборка:

System.Runtime.dll

Получает значение, связанное с заданным ключом.

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

Ключ, значение которого необходимо получить.

value

TValue

Этот метод возвращает значение, связанное с указанным ключом, если он найден; в противном случае — значение по умолчанию для данного типа параметра value. Этот параметр передается неинициализированным.

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

Boolean

Значение true, если объект, реализующий IDictionary<TKey,TValue>, содержит элемент с указанным ключом, в противном случае — значение false.

Исключения

ArgumentNullException

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

Примеры

В примере показано, как использовать TryGetValue метод для получения значений. Если программа часто пытается использовать значения ключей, которых нет в словаре, метод может быть более эффективным, TryGetValue чем использование Item[] свойства (индексатора в C#), которое создает исключения при попытке получить несуществующие ключи.

Этот код является частью более крупного примера, который можно компилировать и выполнять. См. раздел 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[] свойства .

Если ключ не найден, параметр value получает соответствующее значение по умолчанию для типа TValue; например, ноль (0) для целочисленных типов, false для логических типов и null для ссылочных типов.

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

• ContainsKey(TKey)
• Item[TKey]