GetSymbolTypeName

The GetSymbolTypeName and GetSymbolTypeNameWide methods return the name of the specified symbol's type.

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

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

#ifdef UNICODE
#define GetSymbolTypeNameT GetSymbolTypeNameWide
#else
#define GetSymbolTypeNameT GetSymbolTypeName
#endif

Parameters

Index

The index of the symbol whose type 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 name of the symbol's type. 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 name of the symbol's type. If NameSize is NULL, this information is not returned.

Return Value

GetSymbolTypeName and GetSymbolTypeNameWide might return one of the following values:

S_OK

The method was successful.

S_FALSE

The size of the buffer was smaller than the size of the name of the symbol's type. The buffer is filled with the truncated name.

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: Available in IDebugSymbolGroup2 and later versions.

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

See Also

GetNumberSymbols, IDebugSymbols::GetTypeName