IDebugSymbolGroup2::GetSymbolValueText method (dbgeng.h)

Article
02/22/2024

The GetSymbolValueText method returns a string that represents the value of a symbol.

Syntax

HRESULT GetSymbolValueText(
  [in]            ULONG  Index,
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG NameSize
);

Parameters

[in] Index

The index of the symbol whose value you want. The index of a symbol is an identification number. The index ranges from zero through the number of symbols in the symbol group minus one.

[out, optional] Buffer

The value of the symbol as a string. If Buffer is NULL, this information is not returned.

[in] BufferSize

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

[out, optional] NameSize

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

Return value

Return code	Description
S_OK	The method was successful.
S_FALSE	The method was successful. However, the value of the symbol would not fit in the buffer referred to by the Buffer parameter, so a truncated value was returned.

This method can also return error values. For more information, see Return Values.

Remarks

If you added the symbol to the symbol group by using the AddSymbol method, the string that is returned to Buffer is the name of the symbol that is passed to AddSymbol.

For more information about symbol groups, see Scopes and Symbol Groups.

Requirements

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