Keys Method

Returns an array containing all existing keys in a Dictionary object.

Syntax

object.Keys( )

Arguments

Object: Required. Always the name of a Dictionary object.

Remarks

The following code illustrates use of the Keys method:

Example 1:

Function DicDemo
    Dim a, d, i, s   ' Create some variables.
    Set d = CreateObject("Scripting.Dictionary")

    ' Add some keys and items.
    d.Add "a", "Athens"
    d.Add "b", "Belgrade"
    d.Add "c", "Cairo"

    ' Get the keys.
    a = d.Keys

    ' Iterate the array
    For i = 0 To d.Count - 1
        s = s & a(i) ' Create return string
    Next

    DicDemo = s
End Function

' Usage
Dim result
result = DicDemo
' Output: a b c

Example 2:

Function DicKeysWithItems
    Dim a, d, i, s   ' Create some variables.
    Set d = CreateObject("Scripting.Dictionary")

    ' Add some keys and items.
    d.Add "x", "Xenon"
    d.Add "y", "Yttrium"
    d.Add "z", "Zirconium"

    ' Get the keys.
    a = d.Keys

    ' Iterate the array
    For i = 0 To d.Count - 1
        s = s & "Key: " & a(i) & ", Item: " & d.Item(a(i))
    Next

    DicKeysWithItems = s
End Function

' Usage
Dim result
result = DicKeysWithItems
' Output: Key: x, Item: Xenon Key: y, Item: Yttrium Key: z, Item: Zirconium

Example 3:

Function CheckAndRemoveKey(keyToRemove)
    Dim a, d, i, s   ' Create some variables.
    Set d = CreateObject("Scripting.Dictionary")

    ' Add some keys and items.
    d.Add "m", "Moscow"
    d.Add "t", "Tokyo"
    d.Add "n", "New York"

    ' Check and remove key
    If d.Exists(keyToRemove) Then
        d.Remove(keyToRemove)
        s = "Key '" & keyToRemove & "' removed."
    Else
        s = "Key '" & keyToRemove & "' not found."
    End If

    ' Get the remaining keys.
    a = d.Keys
    For i = 0 To d.Count - 1
        s = s & "Remaining Key: " & a(i)
    Next

    CheckAndRemoveKey = s
End Function

' Usage
Dim result
result = CheckAndRemoveKey("t")
' Output: Key 't' removed. Remaining Key: m Remaining Key: n