IDebugRegisters2::GetFrameOffset2 method (dbgeng.h)

The GetFrameOffset2 method returns the location of the stack frame for the current function.

Syntax

HRESULT GetFrameOffset2(
  [in]  ULONG    Source,
  [out] PULONG64 Offset
);

[in] Source

Specifies the register source to query.

The possible values are listed in the following table.

Value	Register source
DEBUG_REGSRC_DEBUGGEE	Fetch register information from the target.
DEBUG_REGSRC_EXPLICIT	Fetch register information from the current explicit register context.
DEBUG_REGSRC_FRAME	Fetch register information from the current scope's register context. Note Stack unwinding does not guarantee accurate updating of the register context, so the scope frame's register context might not be accurate in all cases.

[out] Offset

The location in the process's virtual address space of the stack frame for the current function.

This list does not contain all the errors that might occur. For a list of possible errors, see HRESULT Values.

Return code	Description
S_OK	The method was successful.

The meaning of the value that is returned by this method is architecture-specific.

The method GetFrameOffset performs the same task as this method but always uses the target as the register source.

For an overview of the IDebugRegisters interface and other register-related methods, see Registers.

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