IDebugSymbols3::GetNextSymbolMatch method (dbgeng.h)

Article
02/07/2022

The GetNextSymbolMatch method returns the next symbol found in a symbol search.

Syntax

HRESULT GetNextSymbolMatch(
  [in]            ULONG64  Handle,
  [out, optional] PSTR     Buffer,
  [in]            ULONG    BufferSize,
  [out, optional] PULONG   MatchSize,
  [out, optional] PULONG64 Offset
);

Parameters

[in] Handle

Specifies the handle returned by StartSymbolMatch when the search was initialized.

[out, optional] Buffer

Receives the name of the symbol. If Buffer is NULL, the same symbol will be returned again next time one of these methods are called (with the same handle); this can be used to determine the size of the name of the symbol.

[in] BufferSize

Specifies the size in characters of the buffer. This size includes the space for the '\0' terminating character.

[out, optional] MatchSize

Receives the size in characters of the name of the symbol. This size includes the space for the '\0' terminating character. If MatchSize is NULL, this information is not returned.

[out, optional] Offset

Receives the location in the target's virtual address space of the symbol. If Offset is NULL, this information is not returned.

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.
S_FALSE	The size of the buffer was too small for the name of the symbol, or Buffer was NULL.
E_NOINTERFACE	No more symbols were found matching the pattern.

Remarks

The search must first be initialized by StartSymbolMatch. Once all the desired symbols have been found, EndSymbolMatch can be used to release the 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)