Compartir a través de

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 de

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

[out] pszBuf

Tipo: LPTSTR de

Puntero a un búfer que, cuando este método vuelve 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 de pszBuf.

Valor devuelto

Tipo: BOOL de

Devuelve true si se ejecuta correctamente; De lo contrario, FALSE.

Observaciones

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 la 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 relativos al usuario que realiza la llamada. Esta función no funciona si el usuario se suplanta desde un servicio. Para obtener más información sobre los problemas de control de acceso, consulte Control de acceso.
 
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 se expande.

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 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)

Consulte también

DoEnvironmentSubst