IDebugSymbols::GetFieldOffset method (dbgeng.h)

Article
10/21/2021

The GetFieldOffset method returns the offset of a field from the base address of an instance of a type.

Syntax

HRESULT GetFieldOffset(
  [in]  ULONG64 Module,
  [in]  ULONG   TypeId,
  [in]  PCSTR   Field,
  [out] PULONG  Offset
);

Parameters

[in] Module

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

[in] TypeId

Specifies the type ID of the type containing the field.

[in] Field

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

[out] Offset

Receives the offset of the specified field from the base memory location of an instance of the type.

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 TypeId.

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 location of this field relative to the location of MyStruct structure can be found by setting the Field parameter to "MyField.MySubField".

For more information about types, see Types.

Requirements

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

Share via