PathRemoveFileSpecA function (shlwapi.h)

Article
02/22/2024

Removes the trailing file name and backslash from a path, if they are present.

Note This function is deprecated. We recommend the use of the PathCchRemoveFileSpec function in its place.

Syntax

BOOL PathRemoveFileSpecA(
  [in, out] LPSTR pszPath
);

Parameters

[in, out] pszPath

Type: LPTSTR

A pointer to a null-terminated string of length MAX_PATH that contains the path from which to remove the file name.

Return value

Type: BOOL

Returns nonzero if something was removed, or zero otherwise.

Remarks

Note

The shlwapi.h header defines PathRemoveFileSpec as an alias that 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 is 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