IDebugSymbols3::GetCurrentScopeFrameIndex method (dbgeng.h)

Article
02/22/2024

The GetCurrentScopeFrameIndex method returns the index of the current stack frame in the call stack.

Syntax

HRESULT GetCurrentScopeFrameIndex(
  [out] PULONG Index
);

Parameters

[out] Index

Receives the index of the stack frame corresponding to the current scope. The index counts the number of frames from the top of the call stack. The frame at the top of the stack, representing the current call, has index zero.

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

If the current scope was set using SetScope, Index receives the value of the FrameNumber member of the DEBUG_STACK_TRACE structure passed to the ScopeFrame parameter of SetScope.

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

Requirements

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