Función PathUnExpandEnvStringsA (shlwapi.h)

  • Artículo

Reemplaza determinados nombres de carpeta en una ruta de acceso completa por su cadena de entorno asociada.

Sintaxis

BOOL PathUnExpandEnvStringsA(
  [in]  LPCSTR pszPath,
  [out] LPSTR  pszBuf,
  [in]  UINT   cchBuf
);

Parámetros

[in] pszPath

Tipo: LPCTSTR

Puntero a una cadena terminada en null de longitud máxima MAX_PATH que contiene la ruta de acceso que se va a no ampliar.

[out] pszBuf

Tipo: LPTSTR

Puntero a un búfer que, cuando este método devuelve correctamente, recibe la cadena no expandida. El tamaño de este búfer debe establecerse en MAX_PATH para asegurarse de que es lo suficientemente grande como para contener la cadena devuelta.

[in] cchBuf

Tipo: UINT

Tamaño, en caracteres, en el búfer pszBuf .

Valor devuelto

Tipo: BOOL

Devuelve TRUE si se ejecuta correctamente; de lo contrario, FALSE.

Comentarios

Las siguientes rutas de acceso de carpeta se reemplazan por su cadena de entorno equivalente.

Carpeta Cadena de entorno
La carpeta de perfil Todos los usuarios %ALLUSERSPROFILE%
Carpeta de datos de aplicación del usuario actual (solo Windows Vista y versiones posteriores). %APPDATA%
Nombre del sistema %COMPUTERNAME%
Carpeta Archivos de programa %ProgramFiles%
Carpeta raíz del sistema %SystemRoot%
Letra de unidad del sistema %SystemDrive%
Carpeta de perfil del usuario actual %USERPROFILE%
 
Nota %APPDATA% y %USERPROFILE% son relativas al usuario que realiza la llamada. Esta función no funciona si el usuario se está suplantando desde un servicio. Para obtener más información sobre los problemas de control de acceso, consulte Access Control.
 
Es posible que las variables de entorno enumeradas en la tabla anterior no se establezcan en todos los sistemas. Si no se establece una variable de entorno, no está expandida.

Nota

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

Consulte también

DoEnvironmentSubst