Name

Dictionary.Exists Method

Syntax

                  dictionaryobject.Exists(key)
dictionaryobject

Use: Required

Data Subtype: Dictionary object

A reference to a Dictionary object.

key

Use: Required

Data Subtype: String

The key value being sought.

Return Value

Boolean

Description

Determines whether a given key is present in a Dictionary object.

Rules at a Glance

Returns True if the specified key exists in the Dictionary object; False if not.

Programming Tips & Gotchas

  • If you attempt to use the Item property to return the item of a nonexistent key, or if you assign a new key to a nonexistent key, the nonexistent key is added to the dictionary, along with a blank item. To prevent this, you should use the Exists property to ensure that the Key is present in the dictionary before proceeding.

  • The way in which key is compared with the existing key values is determined by the setting of the Dictionary object’s CompareMode property.

Example

If oDict.Exists(strOldKey) Then
    oDict.Key(strOldKey) = strNewKey
End If

Get VBScript in a Nutshell now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.