PathIsSameRootA function (shlwapi.h)

Article
02/22/2024

Compares two paths to determine if they have a common root component.

Syntax

BOOL PathIsSameRootA(
  [in] LPCSTR pszPath1,
  [in] LPCSTR pszPath2
);

Parameters

[in] pszPath1

Type: LPCTSTR

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

[in] pszPath2

Type: LPCTSTR

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

Return value

Type: BOOL

Returns TRUE if both strings have the same root component, or FALSE otherwise. If pszPath1 contains only the server and share, this function also returns FALSE.

Remarks

Note

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