Interaction.SaveSetting(String, 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.

Saves or creates an application entry in the Windows registry. The My feature gives you greater productivity and performance in registry operations than SaveSetting. For more information, see Registry.

public:
 static void SaveSetting(System::String ^ AppName, System::String ^ Section, System::String ^ Key, System::String ^ Setting);

[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static void SaveSetting (string AppName, string Section, string Key, string Setting);

public static void SaveSetting (string AppName, string Section, string Key, string Setting);

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

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

Public Sub SaveSetting (AppName As String, Section As String, Key As String, Setting As String)

Parameters

AppName: String

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

Section: String

Required. String expression containing the name of the section in which the key setting is being saved.

Key: String

Required. String expression containing the name of the key setting being saved.

Setting: String

Required. Expression containing the value to which Key is being set.

Attributes: SupportedOSPlatformAttribute

Exceptions

ArgumentException

Key registry could not be created, or user is not logged in.

Examples

The following example first uses the SaveSetting function to make entries in the Windows registry for the MyApp application, and then uses the DeleteSetting function to remove them.

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

Remarks

The SaveSetting function adds the key to HKEY_CURRENT_USER\Software\VB and VBA Program Settings.

If the key setting cannot be saved for any reason, an error occurs.

SaveSetting 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.

SaveSetting requires Write and Create RegistryPermission.

Applies to