Hashtable: Add

Add

Adds an element with the specified key and value into the Hashtable.



 Public Sub Add(
	  ByRef Key As Variant,
	  ByRef Value As Variant )

Parameters

Key
[ByRef] Variant. The key of the element to add.
Value
[ByRef] Variant. The value of the element to add.

Remarks

An object that has no correlation between its state and its hash code value should typically not be used as the key. For example, String values are better than StringBuilder objects for use as keys.

You can also use the Item property to add new elements by setting the value of a key that does not exist in the Hashtable; for example, myCollection("myNonexistentKey") = myValue. However, if the specified key already exists in the Hashtable, setting the Item property overwrites the old value. In contrast, the Add method does not modify existing elements.

If Count is less than the capacity of the Hashtable, this method is an O(1) operation. If the capacity needs to be increased to accommodate the new element, this method becomes an O(n) operation, where n is Count.

Exceptions

ExceptionCondition
ArgumentException An element with the same key already exists in the Hashtable.

Examples

The following example shows how to add elements to the Hashtable.

Public Sub Main()
    ' Creates and initializes a new Hashtable.
    Dim MyHT As New Hashtable
    MyHT.Add "one", "The"
    MyHT.Add "two", "quick"
    MyHT.Add "three", "brown"
    MyHT.Add "four", "fox"

    ' Displays the Hashtable.
    Debug.Print "The Hashtable contains the following:"
    PrintKeysAndValues MyHT
End Sub

Public Sub PrintKeysAndValues(ByVal MyHT As Hashtable)
    Dim de As DictionaryEntry
    
    Debug.Print t("\t-KEY-\t-VALUE-")
    
    For Each de In MyHT
        Debug.Print CorString.Format(t("\t{0}:\t{1}"), de.Key, de.Value)
    Next de
    
    Debug.Print
End Sub


' This example code produces the following output.
'
'    The Hashtable contains the following:
'        -KEY-   -VALUE-
'        one:    The
'        two:    quick
'        four:   fox
'        three:  brown

See Also

Project CorLib Overview

Class Hashtable Overview

Remove

Item