VB & VBA in a Nutshell: The Language

GetSetting Function

Named Arguments

Yes

Syntax

GetSetting(appname, section, key[, default])

appname

Use: Required

Data Type: String

The name of the application.

section

Use: Required

Data Type: String

The path from the application key to the key containing the value entries.

key

Use: Required

Data Type: String

The name of the value entry whose value is to be returned.

default

Use: Optional

Data Type: String

The value to return if no value can be found.

Return Value

A string containing the value of the specified key ; default if key, section, or appname aren't found.

Description

Returns a single value from a specified section of your application's entry in the HKEY_CURRENT_USER\Software\VB and VBA Program Settings\ branch of the registry.

Rules at a Glance

• If appname, section, or key isn't found in the registry, GetSetting returns default.

• If default is omitted, it's assumed to be a zero-length string ("").

• The function retrieves a value from a subkey of the HKEY_CURRENT_USER\Software\VB and VBA Program Settings key of the registry.

• section need not be an immediate subkey of appname ; instead, section can be a fully qualified path to a nested subkey, with each subkey separated from its parent by a backslash. For example, a value of Settings\Coordinates for the section argument indicates that the value is to be retrieved from HKEY_CURRENT_USER\Software\VB and VBA Program Settings\appname\Settings\Coordinates.

Programming Tips and Gotchas

• GetSetting is a function that was developed ...