Export (0) Print
Expand All

Hashtable.ContainsKey Method

Determines whether the Hashtable contains a specific key.

Namespace:  System.Collections
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public Overridable Function ContainsKey ( _
	key As Object _
) As Boolean

Parameters

key
Type: System.Object

The key to locate in the Hashtable.

Return Value

Type: System.Boolean
true if the Hashtable contains an element with the specified key; otherwise, false.

ExceptionCondition
ArgumentNullException

key is Nothing.

This method behaves exactly as Contains.

This method is an O(1) operation.

Starting with the .NET Framework 2.0, this method uses the collection’s objects’ Equals and CompareTo methods on item to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the Equals and CompareTo methods of the item parameter on the objects in the collection.

The following example shows how to determine whether the Hashtable contains a specific element.

Imports System
Imports System.Collections

Public Class SamplesHashtable

    Public Shared Sub Main()

        ' Creates and initializes a new Hashtable. 
        Dim myHT As New Hashtable()
        myHT.Add(0, "zero")
        myHT.Add(1, "one")
        myHT.Add(2, "two")
        myHT.Add(3, "three")
        myHT.Add(4, "four")

        ' Displays the values of the Hashtable.
        Console.WriteLine("The Hashtable contains the following values:")
        PrintIndexAndKeysAndValues(myHT)

        ' Searches for a specific key. 
        Dim myKey As Integer = 2
        Console.Write("The key ""{0}"" is ", myKey)
        If(myHT.ContainsKey(myKey))
           Console.WriteLine("in the Hashtable.")
        Else
           Console.WriteLine("NOT in the Hashtable.")
        End If

        myKey = 6
        Console.Write("The key ""{0}"" is ", myKey)
        If(myHT.ContainsKey(myKey))
           Console.WriteLine(" in the Hashtable.")
        Else
           Console.WriteLine(" NOT in the Hashtable.")
        End If 

        ' Searches for a specific value. 
        Dim myValue As String = "three"
        Console.Write("The value ""{0}"" is ", myValue)
        If(myHT.ContainsValue(myValue))
           Console.WriteLine(" in the Hashtable.")
        Else
           Console.WriteLine(" NOT in the Hashtable.")
        End If

        myValue = "nine"
        Console.Write("The value ""{0}"" is ", myValue)
        If(myHT.ContainsValue(myValue))
           Console.WriteLine(" in the Hashtable.")
        Else
           Console.WriteLine(" NOT in the Hashtable.")
        End If 

    End Sub 'Main

    Public Shared Sub PrintIndexAndKeysAndValues(myHT As Hashtable)
        Dim i As Integer = 0
        Console.WriteLine(vbTab + "-INDEX-" + vbTab + "-KEY-" + vbTab + "-VALUE-")
        Dim de As DictionaryEntry
        For Each de In  myHT
            Console.WriteLine(vbTab + "[{0}]:" + vbTab + "{1}" + vbTab + "{2}", i, de.Key, de.Value)
            i = i + 1
        Next de
        Console.WriteLine()
    End Sub 'PrintIndexAndKeysAndValues

End Class 'SamplesHashtable 


' This code produces the following output. 
'  
' The Hashtable contains the following values: 
'         -INDEX- -KEY-   -VALUE- 
'         [0]:    4       four 
'         [1]:    3       three 
'         [2]:    2       two 
'         [3]:    1       one 
'         [4]:    0       zero 

' The key "2" is in the Hashtable. 
' The key "6" is NOT in the Hashtable. 
' The value "three" is in the Hashtable. 
' The value "nine" is NOT in the Hashtable.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft