IDebugSymbols3::GetScope method (dbgeng.h)

The GetScope method returns information about the current scope.

Syntax

HRESULT GetScope(
  [out, optional] PULONG64           InstructionOffset,
  [out, optional] PDEBUG_STACK_FRAME ScopeFrame,
  [out, optional] PVOID              ScopeContext,
  [in]            ULONG              ScopeContextSize
);

Parameters

[out, optional] InstructionOffset

Receives the location in the process's virtual address space of the current scope's current instruction.

[out, optional] ScopeFrame

Receives the DEBUG_STACK_FRAME structure representing the current scope's stack frame.

[out, optional] ScopeContext

Receives the current scope's thread context. The type of the thread context is the CONTEXT structure for the target's effective processor. The buffer ScopeContext must be large enough to hold this structure.

[in] ScopeContextSize

Specifies the size of the buffer ScopeContext.

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_INVALIDARG
The size of the buffer ScopeContext was not large enough to hold the scope's context.

Remarks

For more information about scopes, see Scopes and Symbol Groups.

Requirements

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

See also

IDebugControl::GetEffectiveProcessorType

IDebugSymbols

IDebugSymbols2

IDebugSymbols3

ResetScope

SetScope