Функция SHEnumValueA (shlwapi.h)
Перечисляет значения указанного открытого раздела реестра.
Синтаксис
LSTATUS SHEnumValueA(
[in] HKEY hkey,
[in] DWORD dwIndex,
PSTR pszValueName,
[in, out, optional] LPDWORD pcchValueName,
[out, optional] LPDWORD pdwType,
void *pvData,
[in, out, optional] LPDWORD pcbData
);
Параметры
[in] hkey
Тип: HKEY
Дескриптор открытого ключа или любое из следующих предопределенных значений.
HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_PERFORMANCE_DATA
HKEY_USERS
[in] dwIndex
Тип: DWORD
Индекс извлекаемого значения. Этот параметр должен быть равен нулю для первого вызова и увеличиваться для последующих вызовов.
pszValueName
Тип: LPTSTR
Адрес буфера символов, который получает имя перечисленного значения. Размер этого буфера указывается в параметре pcchValueName.
[in, out, optional] pcchValueName
Тип: LPDWORD
Адрес DWORD , который в записи содержит размер буфера в pszValueName в символах. При выходе содержит количество символов, скопированных в pszValueName.
[out, optional] pdwType
Тип: LPDWORD
Адрес DWORD , который получает тип данных значения. Это те же значения, что и описанные в параметре lpTyperegEnumValue.
pvData
Тип: LPVOID
Адрес буфера, который получает данные для записи значения. Размер этого буфера указывается в pcbData. Этот параметр может иметь значение NULL , если данные не требуются.
[in, out, optional] pcbData
Тип: LPDWORD
Адрес DWORD , который в записи содержит размер буфера в pvData в байтах. При выходе он содержит количество байтов, скопированных в pvData.
Возвращаемое значение
Тип: LSTATUS
Возвращает ERROR_SUCCESS в случае успешного выполнения, или ненулевой код ошибки, определенный в Winerror.h, в противном случае. Для получения текстового описания ошибки можно использовать функцию FormatMessage с флагом FORMAT_MESSAGE_FROM_SYSTEM.
Комментарии
Примечание
Заголовок shlwapi.h определяет SHEnumValue в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows 2000 Professional, Windows XP [только классические приложения] |
Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
Целевая платформа | Windows |
Header | shlwapi.h |
Библиотека | Shlwapi.lib |
DLL | Shlwapi.dll (версия 4.71 или более поздняя) |