PathUnExpandEnvStringsA 函式 (shlwapi.h)

  • 發行項

以相關聯的環境字串取代完整路徑中的特定資料夾名稱。

語法

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

參數

[in] pszPath

類型： LPCTSTR

長度上限之 null 終止字串的指標，MAX_PATH包含要取消展開的路徑。

[out] pszBuf

類型： LPTSTR

當這個方法成功傳回時，緩衝區的指標會收到未展開的字串。 這個緩衝區的大小必須設定為MAX_PATH，以確保它夠大，足以保存傳回的字串。

[in] cchBuf

類型： UINT

pszBuf緩衝區的大小，以字元為單位。

傳回值

類型： BOOL

如果成功，則傳回 TRUE ;否則為 FALSE。

備註

下列資料夾路徑會由其相等的環境字串取代。

資料夾 環境字串
[所有使用者] 設定檔資料夾 %ALLUSERSPROFILE%
目前使用者的應用程式資料檔案夾只會 (Windows Vista 和更新版本) 。 %APPDATA%
系統名稱 %COMPUTERNAME%
Program Files 資料夾 %ProgramFiles%
系統根資料夾 %SystemRoot%
系統磁碟機號 %SystemDrive%
目前使用者的設定檔資料夾 %USERPROFILE%
 
注意 %APPDATA% 和 %USERPROFILE% 相對於進行呼叫的使用者。 如果使用者從服務模擬，此函式將無法運作。 如需存取控制問題的進一步討論，請參閱存取控制。
 
上表中所列的環境變數可能不會在所有系統上設定。 如果未設定環境變數，則不會取消展開。

注意

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

需求

   
最低支援的用戶端 Windows 2000 Professional、Windows XP [僅限桌面應用程式]
最低支援的伺服器 Windows 2000 Server [僅限桌面應用程式]
目標平台 Windows
標頭 shlwapi.h
程式庫 Shlwapi.lib
Dll Shlwapi.dll (5.0 版或更新版本)

另請參閱

DoEnvironmentSubst