DkmCallStackFilterList.FilterNextFrame Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Debugger.CallStack
Assembly:
Microsoft.VisualStudio.Debugger.Engine.dll
Package:
Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Provides a filter with the next stack frame. A filter can simply pass this frame on through, it can suppress the frame by returning nothing, or it can provide its own set of annotated frames. The stack provider will ignore NotImplementedException (E_NOTIMPL). All other errors will truncate stack walk.

Location constraint: API must be called from an IDE component (component level > 100,000).

public:
 cli::array <Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^> ^ FilterNextFrame(int ImplementationIndex, Microsoft::VisualStudio::Debugger::CallStack::DkmStackContext ^ StackContext, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ Input);
public Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame[] FilterNextFrame (int ImplementationIndex, Microsoft.VisualStudio.Debugger.CallStack.DkmStackContext StackContext, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame Input);
public Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame[] FilterNextFrame (int ImplementationIndex, Microsoft.VisualStudio.Debugger.CallStack.DkmStackContext StackContext, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame? Input);
member this.FilterNextFrame : int * Microsoft.VisualStudio.Debugger.CallStack.DkmStackContext * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame -> Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame[]
Public Function FilterNextFrame (ImplementationIndex As Integer, StackContext As DkmStackContext, Input As DkmStackWalkFrame) As DkmStackWalkFrame()

Parameters

ImplementationIndex
Int32

[In] Zero-based index into the collection of {0} implementations that the caller wishes to be invoked. This should be less than the 'Count' property.

StackContext
DkmStackContext

[In] DkmStackContext objects are created by components that wish to request the stack from the stack provider. A component needs to close the context after they have completed the stack walk. To obtain the stack a component should create this object and then call GetNextFrames.

Input
DkmStackWalkFrame

[In,Optional] Input is the next frame to examine. After all frame have been filtered, this function will be called one last time with a null input frame. This lets the filter know that the call stack is fully processed.

Returns

DkmStackWalkFrame[]

[Out] DkmStackWalkFrame[] represents a frame on a call stack which has been walked, but may not have been formatted or filtered. Formatted frames are represented by DkmStackFrame instead.

Applies to