Función SHEnumValueA (shlwapi.h)

Enumera los valores de la clave del Registro abierta especificada.

Sintaxis

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
);

Parámetros

[in] hkey

Tipo: HKEY

Identificador de la clave abierta actualmente o cualquiera de los siguientes valores predefinidos.

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in] dwIndex

Tipo: DWORD

Índice del valor que se va a recuperar. Este parámetro debe ser cero para la primera llamada e incrementada para las llamadas posteriores.

pszValueName

Tipo: LPTSTR

Dirección de un búfer de caracteres que recibe el nombre del valor enumerado. El tamaño de este búfer se especifica en pcchValueName.

[in, out, optional] pcchValueName

Tipo: LPDWORD

La dirección de un DWORD que, en la entrada, contiene el tamaño del búfer en pszValueName, en caracteres. Al salir, contiene el número de caracteres que se copiaron en pszValueName.

[out, optional] pdwType

Tipo: LPDWORD

Dirección de un DWORD que recibe el tipo de datos del valor. Estos son los mismos valores que los descritos en el parámetro lpType de RegEnumValue.

pvData

Tipo: LPVOID

Dirección de un búfer que recibe los datos de la entrada de valor. El tamaño de este búfer se especifica en pcbData. Este parámetro puede ser NULL si los datos no son necesarios.

[in, out, optional] pcbData

Tipo: LPDWORD

La dirección de un DWORD que, en la entrada, contiene el tamaño del búfer en pvData, en bytes. Al salir, contiene el número de bytes que se copiaron en pvData.

Valor devuelto

Tipo: LSTATUS

Devuelve ERROR_SUCCESS si se ejecuta correctamente o si un código de error distinto de cero definido en Winerror.h de lo contrario. Puede usar la función FormatMessage con la marca FORMAT_MESSAGE_FROM_SYSTEM para recuperar una descripción textual del error.

Comentarios

Nota

El encabezado shlwapi.h define SHEnumValue 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 neutro 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

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	shlwapi.h
Library	Shlwapi.lib
Archivo DLL	Shlwapi.dll (versión 4.71 o posterior)