Función SHGetValueA (shlwapi.h)

Recupera un valor del Registro.

Sintaxis

LSTATUS SHGetValueA(
  [in]                HKEY   hkey,
  [in, optional]      LPCSTR pszSubKey,
  [in, optional]      LPCSTR pszValue,
  [out, optional]     DWORD  *pdwType,
  [out, optional]     void   *pvData,
  [in, out, optional] DWORD  *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, optional] pszSubKey

Tipo: LPCTSTR

Dirección de una cadena terminada en null que especifica el nombre de la subclave de la que se va a recuperar el valor.

[in, optional] pszValue

Tipo: LPCTSTR

Dirección del valor.

[out, optional] pdwType

Tipo: LPDWORD

Tipo del valor. Para obtener más información, consulte Tipos de datos del Registro.

[out, optional] pvData

Tipo: LPVOID

Dirección del búfer de datos de destino.

[in, out, optional] pcbData

Tipo: LPDWORD

Tamaño del búfer de datos de destino.

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 genérica del error.

Comentarios

Si la aplicación debe establecer o recuperar una serie de valores en la misma clave, es mejor abrir la clave una vez y establecer o recuperar los valores con las funciones normales del Registro de Microsoft Win32 en lugar de usar esta función repetidamente.

Nota

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

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)