拿掉路徑中的所有檔案和目錄專案,但根資訊除外。
此函式與 PathStripToRoot 不同,因為它接受具有 “\”、“\?” 和 “\?\UNC” 前置詞的路徑。
注意 此函式應該用來取代 PathStripToRoot ,以避免發生緩衝區溢出的可能性。
語法
WINPATHCCHAPI HRESULT PathCchStripToRoot(
[in, out] PWSTR pszPath,
[in] size_t cchPath
);
參數
[in, out] pszPath
路徑字串的指標。 當此函式成功傳回時,此字串只會包含從該路徑取得的根資訊。
[in] cchPath
pszPath 指向的緩衝區大小,以字元為單位。
傳回值
如果路徑已截斷,則此函式會傳回S_OK,S_FALSE路徑已經只是根目錄或 HRESULT 失敗碼。
備註
此函式效果的一些範例:
| 初始字串 | 最終字串 |
|---|---|
| “C:\path1\path2\file” | "C:\" |
| “\\path1\path2\path3” | “\\path1\path2” |
| “\path1” | "\" |
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | Windows 8 [傳統型應用程式 |UWP 應用程式] |
| 最低支援的伺服器 | Windows Server 2012 [傳統型應用程式 |UWP 應用程式] |
| 目標平台 | Windows |
| 標頭 | pathcch.h |
| 程式庫 | Pathcch.lib |