PathRenameExtensionA function (shlwapi.h)

Article
02/22/2024

Replaces the extension of a file name with a new extension. If the file name does not contain an extension, the extension will be attached to the end of the string.

Note Misuse of this function can lead to a buffer overrun. We recommend the use of the safer PathCchRenameExtension function in its place.

Syntax

BOOL PathRenameExtensionA(
  [in, out] LPSTR  pszPath,
  [in]      LPCSTR pszExt
);

Parameters

[in, out] pszPath

Type: LPTSTR

Pointer to a null-terminated string of length MAX_PATH in which to replace the extension.

[in] pszExt

Type: LPCTSTR

Pointer to a character buffer that contains a '.' character followed by the new extension.

Return value

Type: BOOL

Returns nonzero if successful, or zero if the new path and extension would exceed MAX_PATH characters.

Remarks

Note

The shlwapi.h header defines PathRenameExtension as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shlwapi.h
Library	Shlwapi.lib
DLL	Shlwapi.dll (version 4.71 or later)

Share via