IDebugSymbols3::StartSymbolMatch method (dbgeng.h)

Article
02/22/2024

The StartSymbolMatch method initializes a search for symbols whose names match a given pattern.

Syntax

HRESULT StartSymbolMatch(
  [in]  PCSTR    Pattern,
  [out] PULONG64 Handle
);

Parameters

[in] Pattern

Specifies the pattern for which to search. The search will return all symbols whose names match this pattern. For details of the syntax of the pattern, see Symbol Syntax and Symbol Matching and String Wildcard Syntax.

[out] Handle

Receives the handle identifying the search. This handle can be passed to GetNextSymbolMatch and EndSymbolMatch.

Return value

This method may also return other error values. See Return Values for more details.

Return code	Description
S_OK	The method was successful.
E_NOINTERFACE	The specified module was not found.

Remarks

This method initializes a symbol search. The results of the search can be obtained by repeated calls to GetNextSymbolMatch. When all the desired results have been found, use EndSymbolMatch to release resources the engine holds for the search.

For more information about symbols, see Symbols.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h (include Dbgeng.h)