Edit

PathSkipRootA function (shlwapi.h)

  • Article

Retrieves a pointer to the first character in a path following the drive letter or Universal Naming Convention (UNC) server/share path elements.

Syntax

LPCSTR PathSkipRootA(
  [in] LPCSTR pszPath
);

Parameters

[in] pszPath

Type: PTSTR

A pointer to a null-terminated string of maximum length MAX_PATH that contains the path to parse.

Return value

Type: PTSTR

A pointer that, when this function returns successfully, points to the beginning of the subpath that follows the root (drive letter or UNC server/share). If the function encounters an error, this value will be NULL.

Remarks

Note

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

See also

PathCchSkipRoot