Función SHRegGetPathW (shlwapi.h)

  • Artículo

Recupera una ruta de acceso de archivo del Registro y expande las variables de entorno según sea necesario.

Sintaxis

LSTATUS SHRegGetPathW(
  [in]  HKEY    hKey,
  [in]  LPCWSTR pcszSubKey,
  [in]  LPCWSTR pcszValue,
  [out] LPWSTR  pszPath,
        DWORD   dwFlags
);

Parámetros

[in] hKey

Tipo: HKEY

Identificador de una clave que está abierta actualmente o una clave raíz del Registro.

[in] pcszSubKey

Tipo: LPCTSTR

Puntero a una cadena terminada en null que contiene el nombre de la subclave.

[in] pcszValue

Tipo: LPCTSTR

Puntero a una cadena terminada en null que contiene el nombre del valor que contiene la cadena de ruta de acceso no expandida.

[out] pszPath

Tipo: LPTSTR

Un búfer que contiene la ruta de acceso expandida. Debe establecer el tamaño de este búfer en MAX_PATH para asegurarse de que es lo suficientemente grande como para contener la cadena devuelta.

dwFlags

Tipo: DWORD

Reservado.

Valor devuelto

Tipo: LSTATUS

Devuelve ERROR_SUCCESS si se ejecuta correctamente o un código de error de Windows de lo contrario.

Comentarios

El tipo de datos del valor del Registro especificado debe ser REG_EXPAND_SZ o REG_SZ. Si tiene el tipo REG_EXPAND_SZ , las variables de entorno de la cadena del Registro se expandirán con ExpandEnvironmentStrings. Si tiene el tipo de datos REG_SZ , las variables de entorno no se expandirán y la cadena a la que apunta pszPath será idéntica a la cadena del Registro.

Las siguientes cadenas de entorno se reemplazarán por su ruta de acceso equivalente.

Cadena de entorno Carpeta
%USERPROFILE% Carpeta de perfil del usuario actual
%ALLUSERSPROFILE% La carpeta de perfil Todos los usuarios
%ProgramFiles% Carpeta Archivos de programa
%SystemRoot% Carpeta raíz del sistema
%SystemDrive% Letra de unidad del sistema
 
Nota %USERPROFILE% es relativa al usuario que realiza la llamada. Esta función no funciona si el usuario se está suplantando desde un servicio.
 

Nota:

El encabezado shlwapi.h define SHRegGetPath 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 5.0 o posterior)