Функция SHRegSetUSValueA (shlwapi.h)
Задает значение подраздела реестра в пользовательском поддереве (HKEY_CURRENT_USER или HKEY_LOCAL_MACHINE).
Синтаксис
LSTATUS SHRegSetUSValueA(
[in] LPCSTR pszSubKey,
[in] LPCSTR pszValue,
[in] DWORD dwType,
[in, optional] const void *pvData,
[in, optional] DWORD cbData,
[in, optional] DWORD dwFlags
);
Параметры
[in] pszSubKey
Тип: LPCTSTR
Указатель на строку, завершаемую null, с именем подраздела.
[in] pszValue
Тип: LPCTSTR
Указатель на строку, завершающуюся нулевым значением, которая указывает имя значения.
[in] dwType
Тип: DWORD
Тип хранимых данных. Этот параметр должен быть типом REG_SZ . Дополнительные сведения см. в разделе Типы данных реестра.
[in, optional] pvData
Тип: LPVOID*
Apointer на строку, завершающуюся null, которая содержит значение, которое необходимо задать для указанного ключа.
[in, optional] cbData
Тип: DWORD
Длина (в байтах) строки, на которую указывает параметр pvData , не включая завершающий символ NULL.
[in, optional] dwFlags
Тип: DWORD
Флаги, указывающие, где должны быть записаны данные.
SHREGSET_HKCU
Запись в HKEY_CURRENT_USER , если она пуста.
SHREGSET_FORCE_HKCU
Запись в HKEY_CURRENT_USER.
SHREGSET_HKLM
Запись в HKEY_LOCAL_MACHINE , если она пуста.
SHREGSET_FORCE_HKLM
Запись в HKEY_LOCAL_MACHINE.
SHREGSET_DEFAULT
Эквивалентно (SHREGSET_FORCE_HKCU | SHREGSET_HKLM).
Возвращаемое значение
Тип: LSTATUS
Возвращает ERROR_SUCCESS в случае успешного выполнения, или ненулевой код ошибки, определенный в Winerror.h, в противном случае. Чтобы получить общее описание ошибки, можно использовать функцию FormatMessage с флагом FORMAT_MESSAGE_FROM_SYSTEM.
Комментарии
Эта функция открывает ключ каждый раз при его использовании. Если код предполагает установку ряда значений в одном ключе, эффективнее открыть ключ один раз с помощью SHRegOpenUSKey , а затем использовать SHRegWriteUSValue для записи данных.
Примечание
Заголовок shlwapi.h определяет SHRegSetUSValue в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows 2000 Professional, Windows XP [только классические приложения] |
Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
Целевая платформа | Windows |
Header | shlwapi.h |
Библиотека | Shlwapi.lib |
DLL | Shlwapi.dll (версия 4.71 или более поздняя) |