ExpandEnvironmentStringsForUserA 函数 (userenv.h)

使用为指定用户建立的环境块展开源字符串。

语法

USERENVAPI BOOL ExpandEnvironmentStringsForUserA(
  [in, optional] HANDLE hToken,
  [in]           LPCSTR lpSrc,
  [out]          LPSTR  lpDest,
  [in]           DWORD  dwSize
);

参数

[in, optional] hToken

类型： HANDLE

用户的令牌，从 LogonUser、 CreateRestrictedToken、 DuplicateToken、 OpenProcessToken 或 OpenThreadToken 函数返回。 令牌必须具有TOKEN_IMPERSONATE和TOKEN_QUERY访问权限。 此外，从 Windows 7 起，令牌还必须具有TOKEN_DUPLICATE访问权限。 有关详细信息，请参阅 Access-Token 对象的访问权限。

如果 hToken 为 NULL，则环境块仅包含系统变量。

[in] lpSrc

类型： LPCTSTR

指向要展开的以 null 结尾的源字符串的指针。

[out] lpDest

类型： LPTSTR

指向接收扩展字符串的缓冲区的指针。

[in] dwSize

类型：DWORD

指定 lpDest 缓冲区的大小（以 TCHAR 为单位）。

返回值

类型： BOOL

如果成功，则为 TRUE;否则为 FALSE。 要获得更多的错误信息，请调用 GetLastError。

注解

下面是一个示例源字符串：

%USERPROFILE%\ntuser.dat

当 ExpandEnvironmentStringsForUser 返回时，目标字符串将展开，如下所示：

C:\Documents and Settings\UserName\ntuser.dat

注意

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

要求

要求	值
最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
目标平台	Windows
标头	userenv.h
Library	Userenv.lib
DLL	Userenv.dll

另请参阅

用户配置文件概述

用户配置文件参考