GetDefaultUserProfileDirectoryW 函式 (userenv.h)

擷取預設使用者配置檔根目錄的路徑。

語法

USERENVAPI BOOL GetDefaultUserProfileDirectoryW(
  [out, optional] LPWSTR  lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

參數

[out, optional] lpProfileDir

類型: LPTSTR

緩衝區的指標,當此函式成功傳回時,會收到預設使用者配置檔目錄的路徑。 將此值設定為 NULL ,以判斷緩衝區的必要大小。

[in, out] lpcchSize

類型: LPDWORD

指定 TCHARlpProfileDir 緩衝區的大小。

如果 lpProfileDir 指定的緩衝區不夠大,或 lpProfileDirNULL,則函式會失敗,而且此參數會收到必要的緩衝區大小,包括終止的 Null 字元。

傳回值

類型: BOOL

如果 成功,則為TRUE;否則為 FALSE。 若要取得擴充的錯誤資訊,請呼叫 GetLastError

備註

以下是 Windows XP 中 GetDefaultUserProfileDirectory 所傳回路徑的範例:

C:\Documents and Settings\Default User

以下是 Windows 7 中 GetDefaultUserProfileDirectory 所傳回路徑的範例:

C:\Users\Default

若要取得此目錄的子目錄路徑,請使用 SHGetFolderPath (Windows XP 和先前的) 或 SHGetKnownFolderPath (Windows Vista) 函式。

注意

userenv.h 標頭會根據 UNICODE 預處理器常數的定義,將 GetDefaultUserProfileDirectory 定義為別名,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例

規格需求

需求
最低支援的用戶端 Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器 Windows 2000 Server [僅限傳統型應用程式]
目標平台 Windows
標頭 userenv.h
程式庫 Userenv.lib
Dll Userenv.dll

另請參閱

GetAllUsersProfileDirectory

GetProfilesDirectory

GetUserProfileDirectory

使用者配置檔概觀

使用者配置文件參考