Export (0) Print
Expand All

Interaction.GetSetting Method

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 My.Computer.Registry Object.

Namespace: Microsoft.VisualBasic
Assembly: Microsoft.VisualBasic (in microsoft.visualbasic.dll)

public static string GetSetting (
	string AppName,
	string Section,
	string Key,
	[OptionalAttribute] string Default
)
public static String GetSetting (
	String AppName, 
	String Section, 
	String Key, 
	/** @attribute OptionalAttribute() */ String Default
)
public static function GetSetting (
	AppName : String, 
	Section : String, 
	Key : String, 
	Default : String
) : String
Not applicable.

Parameters

AppName

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

Section

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

Key

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

Default

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

Return Value

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 My.Computer.Registry Object.

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

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 ReadRegistry Permission.

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

Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft