Interaction.DeleteSetting(String, String, String) Method

Reference

Definition

Namespace:: Microsoft.VisualBasic

Assembly:: Microsoft.VisualBasic.Core.dll

Assembly:: Microsoft.VisualBasic.dll

Source:: Interaction.vb

Source:: Interaction.vb

Source:: Interaction.vb

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Deletes a section or key setting from an application's entry in the Windows registry. The My feature gives you greater productivity and performance in registry operations than the DeleteSetting function. For more information, see Registry .

[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static void DeleteSetting (string AppName, string? Section = default, string? Key = default);

public static void DeleteSetting (string AppName, string Section = default, string Key = default);

[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
static member DeleteSetting : string * string * string -> unit

static member DeleteSetting : string * string * string -> unit

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

Parameters

AppName: String

Required. String expression containing the name of the application or project to which the section or key setting applies.

Section: String

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: String

Optional. String expression containing the name of the key setting being deleted.

Attributes: SupportedOSPlatformAttribute

Exceptions

ArgumentException

User is not logged in.

Examples

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")

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.

Applies to