SHRegSetPathA 函式 (shlwapi.h)
採用檔案路徑、以環境字串取代資料夾名稱,並將產生的字串放在登錄中。
語法
LSTATUS SHRegSetPathA(
[in] HKEY hKey,
[in] LPCSTR pcszSubKey,
[in] LPCSTR pcszValue,
[in] LPCSTR pcszPath,
DWORD dwFlags
);
參數
[in] hKey
類型:HKEY
目前開啟之金鑰的句柄,或登錄根機碼。
[in] pcszSubKey
類型:LPCTSTR
包含現有子機碼名稱之 Null 終止字串的指標。 如果子機碼不存在,SHRegSetPath 將會失敗。
[in] pcszValue
類型:LPCTSTR
具有要保存路徑字串之值名稱之 Null 終止字串的指標。
[in] pcszPath
類型:LPCTSTR
具有完整檔案路徑之 Null 終止字串的指標。
dwFlags
類型:DWORD
保留。
傳回值
類型:LSTATUS
如果成功,則傳回ERROR_SUCCESS,否則傳回 Windows 錯誤碼。
言論
針對 Windows 2000,SHRegSetPath 會使用 PathUnExpandEnvStrings,將資料夾名稱轉換成其對應的環境字元串。 如果替代了任何環境變數,登錄值將會以 REG_EXPAND_SZ 數據類型來設定。 否則,它會使用 REG_SZ 數據類型來設定。
下列資料夾路徑將會由其相等的環境字串取代。
資料夾 | 環境字串 |
---|---|
目前使用者的配置檔資料夾 | %USERPROFILE% |
[所有使用者] 設定檔資料夾 | %ALLUSERSPROFILE% |
Program Files 資料夾 | %ProgramFiles% |
系統根資料夾 | %SystemRoot% |
系統驅動器號 | %SystemDrive% |
附註 %USERPROFILE% 與撥打電話的用戶相對。 如果使用者正從服務模擬,則此函式無法運作。
注意
shlwapi.h 標頭會將SHRegSetPath定義為別名,根據UNICODE預處理器常數的定義,自動選取此函式的ANSI或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows 2000 Professional、Windows XP [僅限傳統型應用程式] |
支援的最低伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | shlwapi.h |
連結庫 | Shlwapi.lib |
DLL | Shlwapi.dll 版 (5.0 版或更新版本) |