PathCchRemoveFileSpec 函式 (pathcch.h)
拿掉路徑字串中的最後一個專案,不論該專案是檔名還是目錄名稱。 元素的前置反斜杠也會移除。
此函式與 PathRemoveFileSpec 不同,因為它接受具有 “\”、“\?” 和 “\?\UNC” 前置詞的路徑。
注意此函式應該用來取代 PathRemoveFileSpec ,以防止緩衝區溢出的可能性。
語法
WINPATHCCHAPI HRESULT PathCchRemoveFileSpec(
[in, out] PWSTR pszPath,
[in] size_t cchPath
);
參數
[in, out] pszPath
完整路徑字串的指標。 當此函式成功傳回時,字串會有其最後一個元素,並移除其前置反斜杠。 此函式不會影響根路徑,例如 “C:”。 在根路徑的情況下,會傳回未變更的路徑字串。 如果路徑字串結尾為尾端反斜杠,則只會移除該反斜杠。
[in] cchPath
pszPath 所指向的緩衝區大小,以字元為單位。
傳回值
如果函式成功,則此函式會傳回S_OK,S_FALSE如果沒有移除任何專案,則傳回錯誤碼。否則傳回錯誤碼。
備註
下表顯示此函式對路徑字串選取範圍的影響。
原始字串 | 傳回的字串 |
---|---|
“C:\path1” | "C:\" |
“C:\path1\path2” | “C:\path1” |
“C:\path1\” | “C:\path1” |
“\\path1\path2\path3” | “\\path1\path2” |
“\path1” | "\" |
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 8 [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2012 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | pathcch.h |
程式庫 | Pathcch.lib |