PathCchRemoveBackslashEx function (pathcch.h)

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

This function differs from PathCchRemoveBackslash in that it can return a pointer to the new end of the string and report the number of unused characters remaining in the buffer.

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

Syntax

WINPATHCCHAPI HRESULT PathCchRemoveBackslashEx(
  [in, out]       PWSTR  pszPath,
  [in]            size_t cchPath,
  [out, optional] PWSTR  *ppszEnd,
  [out, optional] size_t *pcchRemaining
);

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.

[out, optional] ppszEnd

A value that, when this function returns successfully, receives the address of a pointer to end of the new string. If the string is a root path such as "C:", the pointer points to the backslash; otherwise the pointer points to the string's terminating null character.

[out, optional] pcchRemaining

A pointer to a value that, when this function returns successfully, receives the number of unused characters in the destination buffer, including the terminating null character. If the string is a root path such as "C:", this count includes the backslash in that string.

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