Функция GetSetting

Статья
11/05/2008

Обновлен: Ноябрь 2007

Возвращает значение настройки ключа из записи приложения в реестре Windows.

Свойство My предоставляет большую производительность и быстродействие в операциях реестра, чем GetAllSettings. Дополнительные сведения см. в разделе Объект My.Computer.Registry.

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

Параметры

AppName
Требуется. Выражение String, содержащее имя приложения или проекта, чья настройка ключа требуется.
Section
Требуется. Выражение String, содержащее имя раздела, в котором обнаружена настройка ключа.
Key
Требуется. Выражение String, содержащее имя настройки ключа, которое следует вернуть.
Default
Необязательный атрибут. Выражение, содержащее значение, которое следует вернуть, если в настройках Key значение отсутствует. Если этот параметр опущен, то предполагается, что Default является строкой нулевой длины ("").

Исключения

Тип исключения	Номер ошибки	Условия
ArgumentException	5	Один или несколько аргументов не являются выражениями String, или пользователь не вошел в систему.

См. столбец "Номер ошибки", если выполняется обновление приложений Visual Basic 6.0, в которых используется неструктурированная обработка ошибок. (Можно сравнить номер ошибки с Свойство Number (объект Err).) Однако по возможности следует заменять такую систему управления ошибками на Обзор структурной обработки исключений в Visual Basic.

Заметки

Если какие-либо из элементов, указанных в аргументах GetSetting, отсутствуют, то GetSetting возвращает значение Default.

Так как эта функция работает с ключом реестра HKEY_LOCAL_USER, который становится активным только при интерактивном входе в систему, то GetSetting требует входа пользователя в систему.

Параметры реестра, доступные из неинтерактивного процесса (например Mtx.exe) должны быть сохранены в разделе реестра HKEY_LOCAL_MACHINE\Software\ или HKEY_USER\DEFAULT\Software.

GetSetting требует Readполномочий реестра.

Пример

В данном примере сначала используется функция SaveSetting, чтобы сделать записи в реестре Windows для приложения, указанного как AppName, а затем используется функция GetSetting для отображения одного из параметров. Поскольку аргумент Default указан, то какое-либо значение обязательно будет возвращено. Обратите внимание, что имена Section не могут быть извлечены с помощью GetSetting. Наконец, функция DeleteSetting удаляет все записи приложения.

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