Función SHQueryValueExA (shlwapi.h)
Abre una clave del Registro y la consulta para un valor específico.
Sintaxis
LSTATUS SHQueryValueExA(
[in] HKEY hkey,
[in, optional] LPCSTR pszValue,
DWORD *pdwReserved,
[out, optional] DWORD *pdwType,
[out, optional] void *pvData,
[in, out, optional] DWORD *pcbData
);
Parámetros
[in] hkey
Tipo: HKEY
Identificador de la clave actualmente abierta 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, optional] pszValue
Tipo: LPCTSTR
Dirección de la cadena terminada en null que contiene el nombre del valor que se va a consultar.
pdwReserved
Tipo: LPDWORD
Reservado. Debe ser NULL.
[out, optional] pdwType
Tipo: LPDWORD
Dirección de la variable que recibe el tipo de valor de la clave. Para obtener más información, vea Tipos de datos del Registro.
[out, optional] pvData
Tipo: LPVOID
Dirección del búfer que recibe los datos del valor. Este parámetro puede ser NULL si los datos no son necesarios.
[in, out, optional] pcbData
Tipo: LPDWORD
Dirección de la variable que especifica el tamaño, en bytes, del búfer al que apunta el parámetro pvData . Cuando se devuelve la función, esta variable contiene el tamaño de los datos copiados en pvData.
Valor devuelto
Tipo: DWORD
Devuelve ERROR_SUCCESS si se ejecuta correctamente o un código de error distinto de cero definido en Winerror.h en caso contrario. Puede usar la función FormatMessage con la marca FORMAT_MESSAGE_FROM_SYSTEM para recuperar una descripción genérica del error.
Comentarios
Nota
El encabezado shlwapi.h define SHQueryValueEx 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 dar lugar a errores de coincidencia que dan lugar a errores de compilación o 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) |