Export (0) Print
Expand All

DeleteSetting Function

Deletes a section or key setting from an application's entry in the Windows registry.

Public Sub DeleteSetting( _
   ByVal AppName As String, _
   Optional ByVal Section As String = Nothing, _
   Optional ByVal Key As String = Nothing _
)

Parameters

AppName
Required. String expression containing the name of the application or project to which the section or key setting applies.
Section
Required. String expression containing the name of the section from which the key setting is being deleted. If only AppName and Section are provided, the specified section is deleted along with all related key settings.
Key
Optional. String expression containing the name of the key setting being deleted.

Exceptions/Errors

Exception type Error number Condition
ArgumentException 5 Section, AppName, or Key setting does not exist.
ArgumentException 5 User is not logged in.

Remarks

If all arguments are provided, the specified setting is deleted. A run-time error occurs if you attempt to use DeleteSetting on a nonexistent section or key setting.

DeleteSetting requires that a user be logged on since it operates under the HKEY_LOCAL_USER registry key, which is not active until a user logs on interactively.

Registry settings that are to be accessed from a non-interactive process (such as mtx.exe) should be stored under either the HKEY_LOCAL_MACHINE\Software\ or the HKEY_USER\DEFAULT\Software registry keys.

Example

The following example first uses the SaveSetting procedure to make entries in the Windows registry for the MyApp application, and then uses the DeleteSetting function to remove them. Because no Key argument is specified, the whole Startup section is deleted, including the section name and all of its keys.

' Place some settings in the registry.
SaveSetting("MyApp", "Startup", "Top", "75")
SaveSetting("MyApp","Startup", "Left", "50")
' Remove section and all its settings from registry.
DeleteSetting ("MyApp", "Startup")
' Remove MyApp from the registry.
DeleteSetting ("MyApp")

Smart Device Developer Notes

This function is not supported.

Requirements

Namespace: Microsoft.VisualBasic

Module: Interaction

Assembly: Microsoft.Visual Basic .NET Runtime (in Microsoft.VisualBasic.dll)

See Also

GetAllSettings Function | GetSetting Function | SaveSetting Function | ArgumentException Class

Show:
© 2014 Microsoft