GetSymbolName

The GetSymbolName and GetSymbolNameWide methods return the name of a symbol in a symbol group.

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

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

#ifdef UNICODE
#define GetSymbolNameT GetSymbolNameWide
#else
#define GetSymbolNameT GetSymbolName
#endif

Parameters

Index

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

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

BufferSize

The size of the buffer that Buffer points to.

NameSize

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

Return Value

GetSymbolName and GetSymbolNameWide might return one of the following values:

S_OK

The method was successful.

S_FALSE

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

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

Comments

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

Requirements

Versions: GetSymbolName is available in all versions of IDebugSymbolGroup. GetSymbolNameWide is available in IDebugSymbolGroup2 and later versions.

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

See Also

GetNumberSymbols