Función SHRegGetPathA (shlwapi.h)

Artículo
11/20/2024

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

Sintaxis

LSTATUS SHRegGetPathA(
  [in]  HKEY   hKey,
  [in]  LPCSTR pcszSubKey,
  [in]  LPCSTR pcszValue,
  [out] LPSTR  pszPath,
        DWORD  dwFlags
);

Parámetros

[in] hKey

Tipo: HKEY de

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

[in] pcszSubKey

Tipo: LPCTSTR de

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

[in] pcszValue

Tipo: LPCTSTR de

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 de

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 de

Reservado.

Valor devuelto

Tipo: LSTATUS de

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

Observaciones

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 suplanta 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 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 Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	shlwapi.h
biblioteca de	Shlwapi.lib
DLL de	Shlwapi.dll (versión 5.0 o posterior)

Compartir a través de