GetSymbolEntriesByName

The GetSymbolEntriesByName and GetSymbolEntriesByNameWide methods return the symbols whose names match a given pattern.

HRESULT
  IDebugSymbols3::GetSymbolEntriesByName(
    IN PCSTR  Symbol,
    IN ULONG  Flags,
    OUT OPTIONAL PDEBUG_MODULE_AND_ID  Ids,
    IN ULONG  IdsCount,
    OUT OPTIONAL PULONG  Entries
    );

HRESULT
  IDebugSymbols3::GetSymbolEntriesByNameWide(
    IN PCWSTR  Symbol,
    IN ULONG  Flags,
    OUT OPTIONAL PDEBUG_MODULE_AND_ID  Ids,
    IN ULONG  IdsCount,
    OUT OPTIONAL PULONG  Entries
    );

#ifdef UNICODE
#define GetSymbolEntriesByNameT GetSymbolEntriesByNameWide
#else
#define GetSymbolEntriesByNameT GetSymbolEntriesByName
#endif

Parameters

Symbol

Specifies the pattern used to determine which symbols to return. This method returns the symbols whose name matches the string wildcard syntax pattern Symbol.

Flags

Set to zero.

Ids

Receives the symbols. This is an array of IdsCount entries of type DEBUG_MODULE_AND_ID. If Ids is NULL, this information is not returned.

IdsCount

Specifies the number of entries that the array Ids can hold.

Entries

Receives the number of symbols whose names match the pattern Symbol. If entries is NULL, this information is not returned.

Return Value

S_OK

The method was successful.

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

Interface Version

GetSymbolEntriesByName and GetSymbolEntriesByNameWide are available in IDebugSymbols3 and later versions.

Comments

For more information about symbols, see Symbols.

Requirements

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

See Also

GetSymbolEntriesByOffset