Edit

Share via

PathCchSkipRoot function (pathcch.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.

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

Syntax

WINPATHCCHAPI HRESULT PathCchSkipRoot(
  [in]  PCWSTR pszPath,
  [out] PCWSTR *ppszRootEnd
);

Parameters

[in] pszPath

A pointer to the path string.

[out] ppszRootEnd

The address of a pointer that, when this function returns successfully, points to the first character in a path following the drive letter or UNC server/share path elements. If the path consists of only a root, this value will point to the string's terminating null character.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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