IDebugSymbolGroup::GetSymbolName method

The GetSymbolName method returns the name of a symbol in a symbol group.

Syntax


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

Parameters

Index [in]

The index of the symbol whose name 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 [out, optional]

The symbol name. If Buffer is NULL, this information is not returned.

BufferSize [in]

The size of the buffer that Buffer points to.

NameSize [out, optional]

The size of the symbol name. If NameSize is NULL, this information is not returned.

Return value

Return codeDescription
S_OK

The method was successful.

S_FALSE

The method was successful. However, the name of the symbol did not fit in the buffer referred to by the Buffer parameter, so a truncated name was returned.

 

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

Remarks

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

Requirements

Target platform

Desktop

Header

Dbgeng.h (include Dbgeng.h)

See also

IDebugSymbolGroup
IDebugSymbolGroup2
GetNumberSymbols

 

 

Send comments about this topic to Microsoft

Show: