StartSymbolMatch

The StartSymbolMatch and GetNextSymbolMatchWide methods initialize a search for symbols whose names match a given pattern.

HRESULT
  IDebugSymbols::GetNextSymbolMatch(
    IN PCSTR  Pattern,
    OUT PULONG64  Handle
    );

HRESULT
  IDebugSymbols3::GetNextSymbolMatchWide(
    IN PCWSTR  Pattern,
    OUT PULONG64  Handle
    );

#ifdef UNICODE
#define GetNextSymbolMatchT GetNextSymbolMatchWide
#else
#define GetNextSymbolMatchT GetNextSymbolMatch
#endif

Parameters

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.

Handle

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

Return Value

S_OK

The method was successful.

E_NOINTERFACE

The specified module was not found.

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

Interface Version

StartSymbolMatch is available in all versions of IDebugSymbols. StartSymbolMatchWide is available in IDebugSymbols3 and later versions.

Comments

These methods initialize 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

Headers: Defined in Dbgeng.h. Include Dbgeng.h.

See Also

EndSymbolMatch, GetNextSymbolMatch