Función RegEnumKeyExA (winreg.h)

Artículo
03/11/2023

Enumera las subclaves de la clave del Registro abierta especificada. La función recupera información sobre una subclave cada vez que se llama.

Sintaxis

LSTATUS RegEnumKeyExA(
  [in]                HKEY      hKey,
  [in]                DWORD     dwIndex,
  [out]               LPSTR     lpName,
  [in, out]           LPDWORD   lpcchName,
                      LPDWORD   lpReserved,
  [in, out]           LPSTR     lpClass,
  [in, out, optional] LPDWORD   lpcchClass,
  [out, optional]     PFILETIME lpftLastWriteTime
);

Parámetros

[in] hKey

Identificador de una clave del Registro abierta. La clave debe haberse abierto con el derecho de acceso KEY_ENUMERATE_SUB_KEYS. Para obtener más información, consulte Derechos de acceso y seguridad de clave del Registro.

Este identificador lo devuelve la función RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyEx o RegOpenKeyTransacted . También puede ser una de las siguientes claves predefinidas:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in] dwIndex

Índice de la subclave que se va a recuperar. Este parámetro debe ser cero para la primera llamada a la función RegEnumKeyEx y, a continuación, incrementarse para las llamadas posteriores.

Dado que las subclaves no están ordenadas, ninguna subclave nueva tendrá un índice arbitrario. Esto significa que la función puede devolver subclaves en cualquier orden.

[out] lpName

Puntero a un búfer que recibe el nombre de la subclave, incluido el carácter nulo de terminación. La función copia solo el nombre de la subclave, no la jerarquía de claves completa, en el búfer.

Si se produce un error en la función, no se copia ninguna información en este búfer.

Para obtener más información, vea Límites de tamaño de elemento del Registro.

[in, out] lpcchName

Puntero a una variable que especifica el tamaño del búfer especificado por el parámetro lpName , en caracteres. Este tamaño debe incluir el carácter nulo de terminación. Si la función se realiza correctamente, la variable a la que apunta lpcchName contiene el número de caracteres almacenados en el búfer, sin incluir el carácter nulo de terminación.

Para determinar el tamaño de búfer necesario, use la función RegQueryInfoKey para determinar el tamaño de la subclave más grande para la clave identificada por el parámetro hKey .

lpReserved

Este parámetro está reservado y debe ser NULL.

[in, out] lpClass

Puntero a un búfer que recibe la clase definida por el usuario de la subclave enumerada. Este parámetro puede ser NULL.

[in, out, optional] lpcchClass

Puntero a una variable que especifica el tamaño del búfer especificado por el parámetro lpClass , en caracteres. El tamaño debe incluir el carácter nulo de terminación. Si la función se ejecuta correctamente, lpcchClass contiene el número de caracteres almacenados en el búfer, sin incluir el carácter nulo de terminación. Este parámetro solo puede ser NULL si lpClass es NULL.

[out, optional] lpftLastWriteTime

Puntero a la estructura FILETIME que recibe la hora en la que se escribió por última vez la subclave enumerada. Este parámetro puede ser NULL.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es ERROR_SUCCESS.

Si se produce un error en la función, el valor devuelto es un código de error del sistema. Si no hay más subclaves disponibles, la función devuelve ERROR_NO_MORE_ITEMS.

Si el búfer lpName es demasiado pequeño para recibir el nombre de la clave, la función devuelve ERROR_MORE_DATA.

Comentarios

Para enumerar subclaves, una aplicación debe llamar inicialmente a la función RegEnumKeyEx con el parámetro dwIndex establecido en cero. A continuación, la aplicación debe incrementar el parámetro dwIndex y llamar a RegEnumKeyEx hasta que no haya más subclaves (lo que significa que la función devuelve ERROR_NO_MORE_ITEMS).

La aplicación también puede establecer dwIndex en el índice de la última subclave de la primera llamada a la función y reducir el índice hasta que se enumera la subclave con el índice 0. Para recuperar el índice de la última subclave, use la función RegQueryInfoKey .

Mientras una aplicación usa la función RegEnumKeyEx , no debe realizar llamadas a ninguna función de registro que pueda cambiar la clave que se está enumerando.

Tenga en cuenta que las operaciones que acceden a determinadas claves del Registro se redirigen. Para obtener más información, consulte Virtualización del Registro y datos de aplicación de 32 y 64 bits en el Registro.

Nota

En versiones heredadas de Windows, esta API también se expone mediante kernel32.dll.

Ejemplos

Para obtener un ejemplo, vea Enumerar subclaves del Registro.

Nota

El encabezado winreg.h define RegEnumKeyEx como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winreg.h (incluye Windows.h)
Library	Advapi32.lib
Archivo DLL	Advapi32.dll