Edit

Share via

PathCchRemoveExtension function (pathcch.h)

  • Article

Removes the file name extension from a path, if one is present.

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

NoteThis function, should be used in place of PathRemoveExtension to prevent the possibility of a buffer overrun.

Syntax

WINPATHCCHAPI HRESULT PathCchRemoveExtension(
  [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 extension removed. If no extension 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 no extension was found, or an error code otherwise.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header pathcch.h
Library Pathcch.lib