GetScope

The GetScope method returns information about the current scope.

HRESULT
  IDebugSymbols::GetScope(
    OUT OPTIONAL PULONG64  InstructionOffset,
    OUT OPTIONAL PDEBUG_STACK_FRAME  ScopeFrame,
    OUT OPTIONAL PVOID  ScopeContext,
    IN ULONG  ScopeContextSize
    );

Parameters

InstructionOffset

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

ScopeFrame

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

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.

ScopeContextSize

Specifies the size of the buffer ScopeContext.

Return Value

S_OK

The method was successful.

E_INVALIDARG

The size of the buffer ScopeContext was not large enough to hold the scope's context.

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

Interface Version

GetScope is available in all versions of IDebugSymbols.

Comments

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

Requirements

Headers: Defined in Dbgeng.h. Include Dbgeng.h. CONTEXT is defined in Ntddk.h.

See Also

IDebugControl::GetEffectiveProcessorType, ResetScope, SetScope