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

Определение

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

System.Collections.Generic

Сборка:

System.Collections.dll

Исходный код:

Dictionary.cs

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

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. Этот параметр передается неинициализированным.

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

Boolean

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

Реализации

TryGetValue(TKey, TValue) TryGetValue(TKey, TValue)

Исключения

ArgumentNullException

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

Используйте метод , TryGetValue если код часто пытается получить доступ к ключам, которых нет в словаре. Использование этого метода более эффективно, чем перехват, вызываемого KeyNotFoundException свойством Item[] .

Этот метод приближается к операции O(1).

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

• ContainsKey(TKey)
• Item[TKey]