PathIsPrefixA function (shlwapi.h)

Article
02/22/2024

Examines a path to determine if it starts with pszPrefix.

Syntax

BOOL PathIsPrefixA(
  [in] LPCSTR pszPrefix,
  [in] LPCSTR pszPath
);

Parameters

[in] pszPrefix

Type: IN LPCTSTR

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

[in] pszPath

Type: IN LPCTSTR

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

Return value

Type: BOOL

Returns TRUE if pszPath starts with pszPrefix, or FALSE otherwise.

Remarks

Note

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