PathCchCanonicalize 函数 (pathcch.h)

将路径字符串转换为规范形式。

此函数与 PathCchCanonicalizeEx 的不同之处在于，您只能使用长度MAX_PATH的最终路径。

此函数与 PathAllocCanonicalize 的不同之处在于，调用方必须声明返回的字符串的大小，该字符串存储在堆栈中。

此函数不同于 PathCanonicalize ，因为它接受前缀为“\”、“\？”和“\？\UNC”的路径。

注意应使用此函数 PathCchCanonicalizeEx 或 PathAllocCanonicalize 代替 PathCanonicalize ，以防止缓冲区溢出的可能性。

语法

WINPATHCCHAPI HRESULT PathCchCanonicalize(
  [out] PWSTR  pszPathOut,
  [in]  size_t cchPathOut,
  [in]  PCWSTR pszPathIn
);

[out] pszPathOut

指向缓冲区的指针，当此函数成功返回时，该缓冲区接收规范化路径字符串。

[in] cchPathOut

pszPathOut 指向的缓冲区的大小（以字符为单位）。

[in] pszPathIn

指向原始路径字符串的指针。如果此值指向空字符串，或在删除“.”和“..”元素后生成空字符串，则会将单个反斜杠复制到 pszPathOut 指向的缓冲区。

如果此函数成功，则返回 S_OK。否则，它将返回 HRESULT 代码，包括以下内容。

返回代码	说明
E_INVALIDARG	cchPathOut 值大于 PATHCCH_MAX_CCH。
PATHCCH_E_FILENAME_TOO_LONG	路径段超出了标准路径段长度限制（256 个字符）。
E_OUTOFMEMORY	函数无法分配所需大小的缓冲区。

此函数响应路径中嵌入的字符串“.”和“..”。 “..”字符串指示删除紧靠前一个路径段。 “.”字符串指示跳过下一个路径段。请注意，无法删除路径的根段。如果“..”字符串多于路径段，则函数返回S_OK并且 pszPathOut 指向的缓冲区包含单个反斜杠“\”。

所有尾随句点都将从路径中删除，除非前面有“”野生卡字符。在这种情况下，在“”字符之后保留单个句点，但会删除所有其他尾随句点。

如果生成的路径是根驱动器 (“x：”) ，则会 (“x：\”) 追加反斜杠。

此函数不会将 /) (正斜杠转换为 (\) 的反斜杠。对于不受信任的输入，此函数本身不能用于将路径转换为可与子路径或标识的其他路径进行比较的形式。需要该功能的调用方应在使用此函数之前将正斜杠转换为反斜杠。

以下示例演示了这些字符串的效果。