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

Определение

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

System.Collections.Generic

Сборка:

System.Runtime.dll

Определяет, содержится ли элемент с указанным ключом в 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>.

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

Boolean

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

Исключения

ArgumentNullException

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 (!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", 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

Комментарии

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

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