Edit

Share via

SymMatchStringA function (dbghelp.h)

  • Article

Compares the specified string to the specified wildcard expression.

Syntax

BOOL IMAGEAPI SymMatchStringA(
  [in] PCSTR string,
  [in] PCSTR expression,
  [in] BOOL  fCase
);

Parameters

[in] string

The string, such as a symbol name, to be compared to the expression parameter.

[in] expression

The wildcard expression to compare to the string parameter. The wildcard expression supports the inclusion of the * and ? characters. * matches any string and ? matches any single character.

[in] fCase

A variable that indicates whether or not the comparison is to be case sensitive.

Return value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE. To retrieve extended error information, call GetLastError.

Remarks

All DbgHelp functions, such as this one, are single threaded. Therefore, calls from more than one thread to this function will likely result in unexpected behavior or memory corruption. To avoid this, you must synchronize all concurrent calls from more than one thread to this function.

Note

The dbghelp.h header defines SymMatchString 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 10 Build 20348
Minimum supported server Windows 10 Build 20348
Target Platform Windows
Header dbghelp.h
Library Dbghelp.lib
DLL Dbghelp.dll
Redistributable DbgHelp.dll 6.2 or later

See also

DbgHelp Functions