GetUserProfileDirectoryW 函数 (userenv.h)

检索指定用户配置文件的根目录的路径。

语法

USERENVAPI BOOL GetUserProfileDirectoryW(
  [in]            HANDLE  hToken,
  [out, optional] LPWSTR  lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

参数

[in] hToken

类型:HANDLE

用户的令牌,由 LogonUserCreateRestrictedTokenDuplicateTokenOpenProcessTokenOpenThreadToken 函数返回。 令牌必须具有TOKEN_QUERY访问权限。 有关详细信息,请参阅 Access-Token 对象的访问权限

[out, optional] lpProfileDir

类型:LPTSTR

指向缓冲区的指针,当此函数成功返回时,接收指定用户配置文件目录的路径。

[in, out] lpcchSize

类型:LPDWORD

指定 TCHARlpProfileDir 缓冲区的大小。

如果由 lpProfileDir 指定的缓冲区不够大或 lpProfileDirNULL,则该函数将失败,此参数将接收必要的缓冲区大小,包括终止 null 字符。

返回值

类型:BOOL

如果成功,则 TRUE;否则,FALSE。 若要获取扩展的错误信息,请调用 GetLastError

言论

下面是 Windows XP 中 GetUserProfileDirectory 返回的路径示例:

C:\Documents and Settings\Joe

下面是 Windows 7 中 GetUserProfileDirectory 返回的路径示例:

C:\Users\Joe

若要获取此目录的子目录的路径,请使用 SHGetFolderPath(Windows XP 及更早版本)或 SHGetKnownFolderPath (Windows Vista) 函数。

注意

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

要求

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

另请参阅

GetAllUsersProfileDirectory

GetDefaultUserProfileDirectory

GetProfilesDirectory

用户配置文件概述

用户配置文件参考