IDebugControl3::GetNearInstruction method (dbgeng.h)

Article
10/21/2021

The GetNearInstruction method returns the location of a processor instruction relative to a given location.

Syntax

HRESULT GetNearInstruction(
  [in]  ULONG64  Offset,
  [in]  LONG     Delta,
  [out] PULONG64 NearOffset
);

Parameters

[in] Offset

Specifies the location in the process's virtual address space from which to start looking for the desired instruction.

[in] Delta

Specifies the number of instructions from Offset of the desired instruction. If Delta is negative, the returned offset is before Offset (see the Remarks section for more information).

[out] NearOffset

Receives the location in the process's virtual address space of the instruction that is Delta instructions away from Offset.

Return value

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

Return code	Description
S_OK	The method was successful.

Remarks

On some architectures, like x86 and x64, the size of an instruction may vary. On these architectures, when Delta is negative, the desired instruction location might not be uniquely defined. In this case, the debugger engine will search backward from Offset until it encounters a location such that there are the Delta number of instructions between that location and Offset.

Requirements

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

Share via