На главную

On-line справка по Win32 API

Написать письмо
БЕСПЛАТНАЯ ежедневная online лотерея! Выигрывай каждый день БЕСПЛАТНО!
Список всех статей A-B-C-D-E-F-G-H-I-J-K-L-M-N-O-P-Q-R-S-T-U-V-W-X-Y-Z | Скачать Вниз

RegEnumKey



The RegEnumKey function enumerates subkeys of the specified open registry key. The function retrieves the name of one subkey each time it is called. This function is provided for compatibility with Windows version 3.1. Win32-based applications should use the RegEnumKeyEx function.

LONG RegEnumKey(

HKEY hKey, // handle of key to query
DWORD dwIndex, // index of subkey to query
LPTSTR lpName, // address of buffer for subkey name
DWORD cbName // size of subkey buffer
);


Parameters

hKey

Identifies a currently open key or any of the following predefined reserved handle values:

HKEY_CLASSES_ROOT
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS
The keys returned are relative to the key identified by hKey.

dwIndex

Specifies the index of the subkey to retrieve. This value should be zero for the first call to the RegEnumKey function and then incremented for subsequent calls.

Because subkeys are not ordered, any new subkey will have an arbitrary index. This means that the function may return subkeys in any order.

lpName

Points to a buffer that receives the name of the subkey, including the terminating null character. This function copies only the name of the subkey, not the full key hierarchy, to the buffer.

cbName

Specifies the size, in characters, of the buffer pointed to by the lpName parameter, in characters. To determine the required buffer size, use the RegQueryInfoKey function to determine the size of the largest subkey for the key identified by the hKey parameter. The maximum required buffer size is (MAX_PATH + 1) characters.



Return Values

If the function succeeds, the return value is ERROR_SUCCESS.
If the function fails, the return value is a nonzero error code defined in WINERROR.H. You can use the FormatMessage function with the FORMAT_MESSAGE_FROM_SYSTEM flag to get a generic description of the error.

Remarks

To enumerate subkeys, an application should initially call the RegEnumKey function with the dwIndex parameter set to zero. The application should then increment the dwIndex parameter and call the RegEnumKey function until there are no more subkeys (until the function returns ERROR_NO_MORE_ITEMS).
The application can also set dwIndex to the index of the last key on the first call to the function and decrement the index until the subkey with index 0 is enumerated. To retrieve the index of the last subkey, use the RegQueryInfoKey.

While an application is using the RegEnumKey function, it should not make calls to any registration functions that might change the key being queried.
The key identitied by the hKey parameter must have been opened with KEY_ENUMERATE_SUB_KEYS access (KEY_READ access includes KEY_ENUMERATE_SUB_KEYS access). To open the key, use the RegCreateKeyEx or RegOpenKeyEx function.

See Also

RegCloseKey, RegCreateKeyEx, RegDeleteKey, RegEnumKeyEx, RegOpenKeyEx, RegQueryInfoKey, RegQueryValue


Пригласи друзей и счет твоего мобильника всегда будет положительным!
Предыдущая статья
 
Сайт Народ.Ру Интернет
Следующая статья
Пригласи друзей и счет твоего мобильника всегда будет положительным!

RegEnumKey



Функция RegEnumKey перечисляет подключи определенного открытого ключа регистрации. Функция извлекает имя одного подключа всякий раз, когда она названа. Эта функция предусмотрена для совместимости версией Окна 3.1. базирующиеся приложения Win32 должны использовать функцию RegEnumKeyEx.

ДОЛГО (ДЛИНОЙ) RegEnumKey(

HKEY hKey, // РУЧКА ключа на запрос DWORD dwIndex, // индекс подключа на запрос LPTSTR lpName, // адрес буфера для имени подключа DWORD cbName // размер буфера подключа
);


Параметры

hKey

Идентифицирует к настоящему времени открытый ключ или любая из следующей встроенной резервной ручки оценивает:

HKEY_CLASSES_ROOT HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS
Возвращанные ключи - относительно ключа идентифицированного hKey.

dwIndex

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

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

lpName

Точки на буфер, которые получают имя подключа, включая завершающий недействительный символ. Эта функция копирует только имя подключа, не полная ключевая иерархия, в буфер.

cbName

Определяет размер, в символах, буфера указанного, чтобы параметром lpName, в символах. Для того, чтобы определять необходимый буферный размер, используйте функцию RegQueryInfoKey, чтобы определять размер самого большого подключа для ключа идентифицированного параметром hKey. Максимум требовавшийся, чтобы буферный размер был символами (MAX_PATH + 1).



Обратные Величины

Если функция добивается успеха, обратная величина - ERROR_SUCCESS.
Если функция терпит неудачу, обратная величина является ненулевым кодом ошибки определенным в WINERROR.H. Вы можете использовать функцию FormatMessage с флагом FORMAT_MESSAGE_FROM_SYSTEM, чтобы получать общее описание ошибки.

Замечания

Чтобы перечислять подключи, приложение должно первоначально называть функцию RegEnumKey с параметром dwIndex установленным в нуль. Приложение должно затем увеличивать параметр dwIndex и называть функцию RegEnumKey до нет больше подключей (пока функция не возвращает ERROR_NO_MORE_ITEMS).
Приложение может также установить dwIndex в индекс последний раз включать первому вызову в функцию и декремент индекс пока подключ с индексом 0 не будет перечислен. Для того, чтобы извлекать индекс последнего подключа, используйте RegQueryInfoKey.

Пока приложение использует функцию RegEnumKey, оно не должно делать вызовами в любые регистрационные функции, что могло изменить ключ, спрашиванный.
Ключевое identitied параметром hKey по-видимому открыт доступом KEY_ENUMERATE_SUB_KEYS (доступ KEY_READ включает доступ KEY_ENUMERATE_SUB_KEYS). Для того, чтобы открывать ключ, используйте RegCreateKeyEx или функцию RegOpenKeyEx.

Смотри Также

RegCloseKey, RegCreateKeyEx, RegDeleteKey, RegEnumKeyEx, RegOpenKeyEx, RegQueryInfoKey, RegQueryValue


Вверх Version 1.3, Oct 26 2010 © 2007, 2010, mrhx Вверх
 mrhx software  Русский перевод OpenGL  Русский перевод Win32 API
 
Используются технологии uCoz