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

Определение

Пространство имен:
System.Collections.Generic
Сборки:
mscorlib.dll, System.Runtime.dll
Сборки:
netstandard.dll, System.Runtime.dll
Сборка:
System.Runtime.dll
Сборка:
mscorlib.dll
Сборка:
netstandard.dll
Исходный код:
IDictionary.cs
Исходный код:
IDictionary.cs
Исходный код:
TypeAccessException.cs

Возвращает значение, связанное с указанным ключом.

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", 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 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 ссылочных типов.

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

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