GetUserProfileDirectoryA 函式 (userenv.h)
擷取指定使用者設定檔之根目錄的路徑。
語法
USERENVAPI BOOL GetUserProfileDirectoryA(
[in] HANDLE hToken,
[out, optional] LPSTR lpProfileDir,
[in, out] LPDWORD lpcchSize
);
參數
[in] hToken
類型: HANDLE
使用者的權杖,由 LogonUser、 CreateRestrictedToken、 DuplicateToken、 OpenProcessToken或 OpenThreadToken 函式傳回。 權杖必須具有TOKEN_QUERY存取權。 如需詳細資訊,請參閱 Access-Token 物件的存取權限。
[out, optional] lpProfileDir
類型: LPTSTR
緩衝區的指標,當此函式成功傳回時,會收到指定使用者設定檔目錄的路徑。
[in, out] lpcchSize
類型: LPDWORD
以TCHAR指定lpProfileDir緩衝區的大小。
如果 lpProfileDir 指定的緩衝區不夠大,或 lpProfileDir 為 Null,則函式會失敗,而且此參數會收到必要的緩衝區大小,包括終止的 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 [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | userenv.h |
程式庫 | Userenv.lib |
Dll | Userenv.dll |