Key Method

Sets a key in a Dictionary object.

Syntax

object.Key(key) = newkey

Arguments:

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

• Key: Required. Key value being changed.

• Newkey: Required. New value that replaces the specified key.

Remarks

If key is not found when changing a key, a new key is created and its associated item is left empty.

The following example illustrates the use of the Key property:

Example 1:

Function ChangeKey
    Dim d   ' 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"

    ' Change the key "c" to "d"
    d.Key("c") = "d"

    ' Return the associated item for the new key "d"
    ChangeKey = d.Item("d")
End Function

' Usage
Dim result
result = ChangeKey()
' Output: Cairo

Example 2:

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

    ' Add some keys and items.
    d.Add "m", "Moscow"
    d.Add "n", "New York"
    d.Add "p", "Paris"

    ' Update keys
    d.Key("m") = "r"   ' Change "m" to "r"
    d.Key("n") = "s"   ' Change "n" to "s"

    ' Display all items with updated keys
    s = ""
    For Each Key In d.Keys
        s = s & "Key: " & Key & ", Item: " & d.Item(Key)
    Next

    UpdateKeysAndDisplay = s
End Function

' Usage
Dim result
result = UpdateKeysAndDisplay()
' Output: Key: r, Item: Moscow Key: s, Item: New York Key: p, Item: Paris