PathCchRemoveBackslash function (pathcch.h)

Removes the trailing backslash from the end of a path string.

This function differs from PathRemoveBackslash in that it accepts paths with "\", "\?" and "\?\UNC" prefixes.

Syntax

WINPATHCCHAPI HRESULT PathCchRemoveBackslash(
  [in, out] PWSTR  pszPath,
  [in]      size_t cchPath
);

Parameters

[in, out] pszPath

A pointer to the path string. When this function returns successfully, the string contains the path with any trailing backslash removed. If no trailing backslash was found, the string is unchanged.

[in] cchPath

The size of the buffer pointed to by pszPath, in characters.

Return value

This function returns S_OK if the function was successful, S_FALSE if the string was a root path or if no backslash was found, or an error code otherwise.

Remarks

This function will not remove the backslash from a root path string, such as "C:".

Requirements