Функция RegSetValueA (winreg.h)

Статья
08/27/2023

Задает данные для значения по умолчанию или неименованного для указанного раздела реестра. Данные должны быть текстовой строкой.

Примечание Эта функция предоставляется только для совместимости с 16-разрядными версиями Windows. Приложения должны использовать функцию RegSetValueEx .

Синтаксис

LSTATUS RegSetValueA(
  [in]           HKEY   hKey,
  [in, optional] LPCSTR lpSubKey,
  [in]           DWORD  dwType,
  [in]           LPCSTR lpData,
  [in]           DWORD  cbData
);

Параметры

[in] hKey

Дескриптор открытого раздела реестра. Ключ должен быть открыт с правом доступа KEY_SET_VALUE. Дополнительные сведения см. в разделе Безопасность раздела реестра и права доступа.

Этот дескриптор возвращается функцией RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyEx или RegOpenKeyTransacted . Это также может быть один из следующих предопределенных ключей:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in, optional] lpSubKey

Имя подраздела параметра hKey . Функция задает значение по умолчанию для указанного подраздела. Если lpSubKey не существует, функция создает его.

В именах ключей регистр не учитывается.

Если этот параметр имеет значение NULL или указывает на пустую строку, функция задает значение по умолчанию для ключа, определяемого hKey.

Дополнительные сведения см. в разделе Ограничения размера элементов реестра.

[in] dwType

Тип хранимой информации. Этот параметр должен быть типом REG_SZ. Для хранения других типов данных используйте функцию RegSetValueEx .

[in] lpData

Сохраняемые данные. Этот параметр не может иметь значение NULL.

[in] cbData

Этот параметр не учитывается. Функция вычисляет это значение на основе размера данных в параметре lpData .

Возвращаемое значение

Если функция выполняется успешно, возвращаемое значение будет ERROR_SUCCESS.

Если функция завершается сбоем, возвращаемое значение представляет собой ненулевой код ошибки, определенный в Winerror.h. Чтобы получить общее описание ошибки, можно использовать функцию FormatMessage с флагом FORMAT_MESSAGE_FROM_SYSTEM.

Если используется версия ANSI этой функции (путем явного вызова RegSetValueA или путем не определения ЮНИКОДа перед включением файла Windows.h), параметр lpData должен быть строкой символов ANSI. Строка преобразуется в Юникод перед сохранением в реестре.

Примечание

Заголовок winreg.h определяет RegSetValue в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	winreg.h (включая Windows.h)
Библиотека	Advapi32.lib
DLL	Advapi32.dll