DeleteSetting Statement |
Named Arguments
Yes
Syntax
DeleteSetting appname[, section[, key]]
appname
Use: Required
Data Type: String
The name of the application. This must be a subkey of the HKEY_CURRENT_USER\Software\VB and VBA Program Settings registry key.
section
Use: Optional
Data Type: String
The name of the application key's subkey that is to be deleted. section can be a single key or a registry path separated with backslashes.
key
Use: Optional
Data Type: String
The name of the value entry to delete.
Description
Deletes a complete application key, one of its subkeys, or a single value entry from the Windows registry.
Rules at a Glance
section can contain a relative path (similar to that used to describe the folders on a hard drive) to navigate from the application key to the subkey to be deleted. For example, to delete the value entry named TestKey in the registry key HKEY_CURRENT_USER\Software\VB and VBA Program Settings\ RegTester\BranchOne\BranchTwo, you'd use:
DeleteSetting "RegTester", "BranchOne\BranchTwo", _ "TestKey"
You can't use DeleteSetting to delete entries from registry keys that aren't subkeys of HKEY_CURRENT_USER\Software\VB and VBA Program Settings.
If key is supplied, only the value entry named key and its associated value are deleted.
If key is omitted, the subkey named section is deleted.
If section is omitted, the entire application key named appname is deleted.
Example
Sub TestTheReg() SaveSetting "MyRealGoodApp", _ "TestBranch\SomeSection\AnotherSection", ...
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.