PathCchStripToRoot 函数 (pathcch.h)

  • 项目

删除路径中的所有文件和目录元素，根信息除外。

此函数与 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
Library Pathcch.lib