GetSetting Function

Description

Returns a key setting value from an application’s Windows registry entry.

Syntax

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

The GetSetting function syntax has these named arguments:

Part

Description

appname

String expression containing the name of the application or project whose key setting is requested.

section

String expression containing the name of the section where the key setting is found.

key

String expression containing the name of the key setting to return.

default

Expression containing the value to return if no value is set in the key setting. If omitted, default is assumed to be a zero-length string ("").


Remarks

If any of the items named in the GetSetting arguments do not exist, GetSetting returns the value of default.

See Also

DeleteSetting Statement, GetAllSettings Function, SaveSetting Statement.

Example

This example first uses the SaveSetting statement to make entries in the Windows registry (or .INI file on 16-bit Windows platforms) for the application specified as appname, then uses the GetSetting function to display one of the settings. Because the default argument is specified, some value is guaranteed to be returned. Note that section names cannot be retrieved with GetSetting. Finally, the DeleteSetting statement removes all the application’s entries.


' Variant to hold 2-dimensional array returned by GetAllSettings.MySettings As Variant
' Place some settings in the registry.("MyApp","Startup", "Top", 75)("MyApp","Startup", "Left", 50)
.Print GetSetting(appname := "MyApp", section := "Startup", _
    key := "Left", default := "25")
("MyApp", "Startup")