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

Определение

Определяет, содержит ли IDictionary<TKey,TValue> элемент с указанным ключом.

public:
 bool ContainsKey(TKey key);
public bool ContainsKey(TKey key);
abstract member ContainsKey : 'Key -> bool
Public Function ContainsKey (key As TKey) As Boolean

Параметры

key
TKey

Ключ, который нужно найти в элементе IDictionary<TKey,TValue>.

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

trueЗначение , IDictionary<TKey,TValue>если элемент false содержит элемент с ключом; в противном случае .

Исключения

key равно null.

Примеры

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

Этот код является частью более крупного примера, который можно скомпилировать и выполнить. См. System.Collections.Generic.IDictionary<TKey,TValue>.

// ContainsKey can be used to test keys before inserting
// them.
if (!openWith.ContainsKey("ht"))
{
    openWith.Add("ht", "hypertrm.exe");
    Console.WriteLine("Value added for key = \"ht\": {0}",
        openWith["ht"]);
}
' ContainsKey can be used to test keys before inserting 
' them.
If Not openWith.ContainsKey("ht") Then
    openWith.Add("ht", "hypertrm.exe")
    Console.WriteLine("Value added for key = ""ht"": {0}", _
        openWith("ht"))
End If
// 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

Комментарии

Реализации могут отличаться в том, как они определяют равенство объектов; Например, класс используетList<T>, Comparer<T>.Default в то время как Dictionary<TKey,TValue> класс позволяет пользователю указать реализацию, используемую IComparer<T> для сравнения ключей.

Реализации могут различаться в зависимости от того, разрешено key ли они быть null.

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