Interaction.GetSetting(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.

Returns a key setting value from an application's entry in the Windows registry. The My feature gives you greater productivity and performance in registry operations than GetAllSettings. For more information, see Registry.

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

public static string GetSetting (string AppName, string Section, string Key, string Default = "");

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

static member GetSetting : string * string * string * string -> string

Public Function GetSetting (AppName As String, Section As String, Key As String, Optional Default As String = "") As String

Parameters

AppName: String

Required. String expression containing the name of the application or project whose key setting is requested.

Section: String

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

Key: String

Required. String expression containing the name of the key setting to return.

Default: String

Optional. Expression containing the value to return if no value is set in the Key setting. If omitted, Default is assumed to be a zero-length string ("").

Returns

String

A key setting value from an application's entry in the Windows registry.

The My feature gives you greater productivity and performance in registry operations than GetAllSettings.

Attributes: SupportedOSPlatformAttribute

Exceptions

ArgumentException

One or more arguments are not String expressions, or user is not logged in.

Examples

This example first uses the SaveSetting function to make entries in the Windows registry for the application specified as AppName, and then uses the GetSetting function to display one of the settings. Because the Default argument is specified, some value is guaranteed to be returned. Notice that Section names cannot be retrieved with GetSetting. Finally, the DeleteSetting function removes all the application's entries.

' Place some settings in the registry.
SaveSetting("MyApp", "Startup", "Top", "75")
SaveSetting("MyApp", "Startup", "Left", "50")
Console.WriteLine(GetSetting("MyApp", "Startup", "Left", "25"))
DeleteSetting("MyApp")

Remarks

If any of the items named in the GetSetting arguments do not exist, GetSetting returns a value of Default.

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

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.

GetSetting requires Read RegistryPermission.

Applies to

Share via