SaveSetting Statement

Named Arguments

Yes

Syntax

SaveSetting appname, section, key, setting

appname

Use: Required

Data Type: String

The name of the application.

section

Use: Required

Data Type: String

The name of the registry key.

key

Use: Required

Data Type: String

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

setting

Use: Required

Data Type: String or numeric

The value to save.

Description

Creates or saves an entry for a VB application in the Windows registry.

Rules at a Glance

  • If either the appname or section subkeys isn't found in the registry, it's automatically created.

  • The function writes a value to a subkey of the KEY_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.

  • Visual Basic writes setting to the registry as a string (REG_SZ) value. If setting isn't a string, VB attempts to coerce it into a string in order to write it.

  • If the setting can't be saved, a runtime error is generated.

Programming Tips and Gotchas

  • Use the App object's EXEName property to pass your application's name to the GetSetting function.

  • The built-in registry manipulation functions allow you ...

Get VB & VBA in a Nutshell: The Language 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.