GetCurrentScopeFrameIndex

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

HRESULT
  IDebugSymbols3::GetCurrentScopeFrameIndex(
    OUT PULONG  Index
    );

Parameters

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

S_OK

The method was successful.

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

Interface Version

GetCurrentScopeFrameIndex is available in IDebugSymbols3 and later versions.

Comments

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

Headers: Defined in Dbgeng.h. Include Dbgeng.h.

See Also

.frame (Set Local Context), SetScopeFrameByIndex, GetScope