GetSymbolEntryString

The GetSymbolEntryString and GetSymbolEntryStringWide methods return string information for the specified symbol.

HRESULT
  IDebugSymbols3::GetSymbolEntryString(
    IN PDEBUG_MODULE_AND_ID  Id,
    IN ULONG  Which,
    OUT OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  StringSize
    );

HRESULT
  IDebugSymbols3::GetSymbolEntryStringWide(
    IN PDEBUG_MODULE_AND_ID  Id,
    IN ULONG  Which,
    OUT OPTIONAL PWSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  StringSize
    );

#ifdef UNICODE
#define GetSymbolEntryStringT GetSymbolEntryStringWide
#else
#define GetSymbolEntryStringT GetSymbolEntryString
#endif

Parameters

Id

Specifies the symbols whose memory regions are being requested. The DEBUG_MODULE_AND_ID structure contains the module containing the symbol and the symbol ID of the symbol within the module.

Which

Specifies the index of the desired string. Often this is zero, as most symbols contain just one string (their name). But some symbols may contain more than one string — for example, annotation symbols.

Buffer

Receives the name of the symbol. If Buffer is NULL, this information is not returned.

BufferSize

Specifies the size in characters of the buffer Buffer.

StringSize

Receives the size in characters of the symbol's name. If StringSize 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

GetSymbolEntryString is 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

GetSymbolEntriesByName, GetSymbolEntriesByOffset