Edit

Share via

PathStripToRootA function (shlwapi.h)

  • Article

Removes all file and directory elements in a path except for the root information.

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

Syntax

BOOL PathStripToRootA(
  [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 to be converted. When this function returns successfully, this string contains only the root information taken from that path.

Return value

Type: BOOL

Returns TRUE if a valid drive letter was found in the path, or FALSE otherwise.

Remarks

Note

The shlwapi.h header defines PathStripToRoot 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)