PathMatchSpecA function (shlwapi.h)

Article
02/22/2024

Searches a string using a Microsoft MS-DOS wildcard match type.

Syntax

BOOL PathMatchSpecA(
  [in] LPCSTR pszFile,
  [in] LPCSTR pszSpec
);

Parameters

[in] pszFile

Type: LPCSTR

A pointer to a null-terminated string that contains the path to be searched.

[in] pszSpec

Type: LPCSTR

A pointer to a null-terminated string that contains the file type for which to search. For example, to test whether pszFile is a .doc file, pszSpec should be set to "*.doc".

Return value

Type: BOOL

Returns TRUE if the string matches, or FALSE otherwise.

Remarks

Note

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

Share via