IDebugSymbols3::GetFieldName method (dbgeng.h)

Article
02/07/2022

The GetFieldName method returns the name of a field within a structure.

Syntax

HRESULT GetFieldName(
  [in]            ULONG64 Module,
  [in]            ULONG   TypeId,
  [in]            ULONG   FieldIndex,
  [out, optional] PSTR    NameBuffer,
  [in]            ULONG   NameBufferSize,
  [out, optional] PULONG  NameSize
);

Parameters

[in] Module

Specifies the base address of the module in which the structure was defined.

[in] TypeId

Specifies the type ID of the structure.

[in] FieldIndex

Specifies the index of the desired field within the structure.

[out, optional] NameBuffer

Receives the field's name. If NameBuffer is NULL, this information is not returned.

[in] NameBufferSize

Specifies the size in characters of the buffer NameBuffer. This size includes the space for the '\0' terminating character.

[out, optional] NameSize

Receives the size in characters of the field's name. This size includes the space for the '\0' terminating character. If NameSize is NULL, this information is not returned.

Return value

This method may also return error values. See Return Values for more details.

Return code	Description
S_OK	The method was successful.
S_FALSE	The method was successful. However, NameBuffer was not large enough to hold the field's name and it was truncated.

Remarks

For more information about symbols, see Symbols.

Requirements

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

Share via