IDictionary(TKey, TValue).ContainsKey Method
Determines whether the IDictionary(TKey, TValue) contains an element with the specified key.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- key
- Type: TKey
The key to locate in the IDictionary(TKey, TValue).
Return Value
Type: System.Booleantrue if the IDictionary(TKey, TValue) contains an element with the key; otherwise, false.
| Exception | Condition |
|---|---|
| ArgumentNullException | key is a null reference (Nothing in Visual Basic). |
Implementations can vary in how they determine equality of objects; for example, the List(T) class uses Comparer(T).Default, whereas the Dictionary(TKey, TValue) class allows the user to specify the IComparer(T) implementation to use for comparing keys.
Implementations can vary in whether they allow key to be a null reference (Nothing in Visual Basic).
The following code example shows how to use the ContainsKey method to test whether a key exists prior to calling the Add method. It also shows how to use the TryGetValue method, which can be a more efficient way to retrieve values if a program frequently tries key values that are not in the dictionary. Finally, it shows how to insert items using Item property (the indexer in C#).
This code is part of a larger example that can be compiled and executed. See System.Collections.Generic.IDictionary(TKey, TValue).
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.