IDebugSymbols3::GetFieldTypeAndOffset method (dbgeng.h)

Article
02/22/2024

The GetFieldTypeAndOffset method returns the type of a field and its offset within a container.

Syntax

HRESULT GetFieldTypeAndOffset(
  [in]            ULONG64 Module,
  [in]            ULONG   ContainerTypeId,
  [in]            PCSTR   Field,
  [out, optional] PULONG  FieldTypeId,
  [out, optional] PULONG  Offset
);

Parameters

[in] Module

Specifies the module containing the types of both the container and the field.

[in] ContainerTypeId

Specifies the type ID for the container's type. Examples of containers include structures, unions, and classes.

[in] Field

Specifies the name of the field whose type and offset are requested. Subfields may be specified by using a dot-separated path.

[out, optional] FieldTypeId

Receives the type ID of the field.

[out, optional] Offset

Receives the offset of the field Field from the base memory location of an instance of the container.

Return value

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

Return code	Description
S_OK	The method was successful.
E_NOINTERFACE	The field Field could not be found in the type specified by ContainerTypeId.

Remarks

An example of a dot-separated path for the Field parameter is as follows. Suppose the MyStruct structure contains a field MyField of type MySubStruct, and the MySubStruct structure contains the field MySubField. Then the type of this field and its location relative to the location of MyStruct structure can be found by passing "MyField.MySubField" as the Field parameter to this method.

For more information about types, see Types. For more information about symbols, see Symbols.

Requirements

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