Interaction.DeleteSetting Method

'Declaration
Public Shared Sub DeleteSetting ( _
	AppName As String, _
	<OptionalAttribute> Optional Section As String = Nothing, _
	<OptionalAttribute> Optional Key As String = Nothing _
)
'Usage
Dim AppName As String
Dim Section As String
Dim Key As String

Interaction.DeleteSetting(AppName, Section, Key)

public static void DeleteSetting (
	String AppName, 
	/** @attribute OptionalAttribute() */ String Section, 
	/** @attribute OptionalAttribute() */ String Key
)

public static function DeleteSetting (
	AppName : String, 
	Section : String, 
	Key : String
)

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.

For more detailed information, see the Visual Basic topic DeleteSetting Function.

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.

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

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework