Функция DeleteSetting

Статья
11/05/2008

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

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

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

Public Sub DeleteSetting( _
   ByVal AppName As String, _
   Optional ByVal Section As String = Nothing, _
   Optional ByVal Key As String = Nothing _
)

Параметры

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

Исключения

Тип исключения	Номер ошибки	Условия
ArgumentException	5	SectionAppName и параметр Key не существуют.
ArgumentException	5	Пользователь не вошел в систему.

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

Заметки

Если все аргументы предоставлены, указанная настройка удаляется. Ошибки во время выполнения происходят при попытке использовать DeleteSetting для несуществующего раздела или настройки ключа.

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

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

Пример

Следующий пример сначала использует процедуру SaveSetting, чтобы сделать записи в реестре Windows для приложения MyApp, а затем использует функцию DeleteSetting, чтобы удалить их. Поскольку аргумент Key не указан, целый раздел Startup удаляется, включая имя раздела и все его ключи.

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