Edit

Share via

IDebugSymbols3::GetSymbolEntryString method (dbgeng.h)

  • Article

The GetSymbolEntryString method returns string information for the specified symbol.

Syntax

HRESULT GetSymbolEntryString(
  [in]            PDEBUG_MODULE_AND_ID Id,
  [in]            ULONG                Which,
  [out, optional] PSTR                 Buffer,
  [in]            ULONG                BufferSize,
  [out, optional] PULONG               StringSize
);

Parameters

[in] 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.

[in] 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.

[out, optional] Buffer

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

[in] BufferSize

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

[out, optional] StringSize

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

Return value

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

Return code Description
S_OK
 The method was successful.

Remarks

For more information about symbols, see Symbols.

Requirements

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

See also

GetSymbolEntriesByName

GetSymbolEntriesByOffset

IDebugSymbols3