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

Статья
11/20/2024

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

Примечание Эта функция предоставляется только для совместимости с 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 для получения универсального описания ошибки.

Замечания

Если ключ, указанный параметром lpSubKey, не существует, то функция regSetValue создает ее.

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

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winreg.h (включая Windows.h)
библиотеки	Advapi32.lib
DLL	Advapi32.dll