GetSymbolValueText

The GetSymbolValueText and GetSymbolValueTextWide methods return a string that represents the value of a symbol.

HRESULT
  IDebugSymbolGroup2::GetSymbolValueText(
    IN ULONG  Index,
    OUT OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  NameSize
    );

HRESULT
  IDebugSymbolGroup2::GetSymbolValueTextWide(
    IN ULONG  Index,
    OUT OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  NameSize
    );

#ifdef UNICODE
#define GetSymbolValueTextT GetSymbolValueTextWide
#else
#define GetSymbolValueTextT GetSymbolValueText
#endif

Parameters

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.

Buffer

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

BufferSize

The size, in characters, of the Buffer buffer.

NameSize

The size, in characters, of the value of the symbol. If NameSize is NULL, this information is not returned.

Return Value

GetSymbolValueText and GetSymbolValueTextWide might return one of the following values:

S_OK

The method was successful.

S_FALSE

The method was successful. However, the value of the symbol would not fit in the Buffer buffer, so a truncated value was returned.

This method might also return error values. For more information about possible return values, see Return Values.

Comments

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

Versions: Available in IDebugSymbolGroup2 and later versions.

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

See Also

GetNumberSymbols, WriteSymbol