Dictionary<TKey,TValue>.TryGetValue(TKey, TValue) Method

Definition

Получает значение, связанное с заданным ключом.Gets the value associated with the specified key.

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

Parameters

key
TKey

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

value
TValue

Возвращаемое значение, связанное с указанном ключом, если он найден; в противном случае — значение по умолчанию для данного типа параметра value.When this method returns, contains 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.

Returns

Boolean

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

Implements

Exceptions

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

Examples

В примере показано, как использовать метод TryGetValue как более эффективный способ получения значений в программе, которая часто пытается выполнять ключи, которые не находятся в словаре.The example shows how to use the TryGetValue method as a more efficient way to retrieve values in a program that frequently tries keys that are not in the dictionary. Для противоположности в примере также показано, как свойство Item[] (индексатор в C#) создает исключения при попытке получить несуществующие ключи.For contrast, the example also shows how the Item[] property (the indexer in C#) throws exceptions when attempting to retrieve nonexistent keys.

Этот пример кода является частью большого примера, приведенного для класса Dictionary<TKey,TValue> (openWith — имя словаря, используемого в этом примере).This code example is part of a larger example provided for the Dictionary<TKey,TValue> class (openWith is the name of the Dictionary used in this example).

// 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

Remarks

Этот метод сочетает в себе функциональные возможности метода ContainsKey и свойства Item[].This method combines the functionality of the ContainsKey method and the Item[] property.

Если ключ не найден, то параметр value получает соответствующее значение по умолчанию для типа TValue; Например, 0 (ноль) для целочисленных типов, false для логических типов и null для ссылочных типов.If the key is not found, then the value parameter gets the appropriate default value for the type TValue; for example, 0 (zero) for integer types, false for Boolean types, and null for reference types.

Используйте метод TryGetValue, если код часто пытается получить доступ к ключам, которые отсутствуют в словаре.Use the TryGetValue method if your code frequently attempts to access keys that are not in the dictionary. Использование этого метода более эффективно, чем перехват KeyNotFoundException, вызванного свойством Item[].Using this method is more efficient than catching the KeyNotFoundException thrown by the Item[] property.

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

Applies to

See also