PathUnExpandEnvStringsA 函数 (shlwapi.h)

将完全限定路径中的某些文件夹名称替换为其关联的环境字符串。

语法

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

参数

[in] pszPath

类型: LPCTSTR

指向包含要展开的路径的最大长度MAX_PATH以 null 结尾的字符串的指针。

[out] pszBuf

类型: LPTSTR

指向缓冲区的指针,此方法成功返回时,该缓冲区接收未展开的字符串。 此缓冲区的大小必须设置为 MAX_PATH,以确保其大小足以容纳返回的字符串。

[in] cchBuf

类型: UINT

pszBuf 缓冲区中的大小(以字符为单位)。

返回值

类型: BOOL

如果成功,则返回 TRUE ;否则为 FALSE

注解

以下文件夹路径将替换为其等效的环境字符串。

文件夹 环境字符串
“所有用户”配置文件文件夹 %ALLUSERSPROFILE%
当前用户的应用程序数据文件夹 (Windows Vista 及更高版本,仅) 。 %APPDATA%
系统名称 %COMPUTERNAME%
“程序文件”文件夹 %ProgramFiles%
系统根文件夹 %SystemRoot%
系统驱动器号 %SystemDrive%
当前用户的配置文件文件夹 %USERPROFILE%
 
注意 %APPDATA% 和 %USERPROFILE% 相对于进行呼叫的用户。 如果用户从服务中模拟,则此函数不起作用。 有关访问控制问题的进一步讨论,请参阅 访问控制
 
上表中列出的环境变量可能不会全部在所有系统上设置。 如果未设置环境变量,则不会取消扩展。

注意

shlwapi.h 标头将 PathUnExpandEnvStrings 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定

要求

   
最低受支持的客户端 Windows 2000 专业版、Windows XP [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 shlwapi.h
Library Shlwapi.lib
DLL Shlwapi.dll (5.0 或更高版本)

另请参阅

DoEnvironmentSubst