DkmStackContext.GetNextFrames Method

Definition

Obtain the next frames from the call stack. If this is the first call on a particular DkmStackContext then this will return the first frames. This method is the recommended way to obtain the call stack because the stack provider maintains a cache of the physical stack.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

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

public:
 void GetNextFrames(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, int RequestSize, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::CallStack::DkmGetNextFramesAsyncResult> ^ CompletionRoutine);
public void GetNextFrames (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, int RequestSize, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.CallStack.DkmGetNextFramesAsyncResult> CompletionRoutine);
member this.GetNextFrames : Microsoft.VisualStudio.Debugger.DkmWorkList * int * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.CallStack.DkmGetNextFramesAsyncResult> -> unit
Public Sub GetNextFrames (WorkList As DkmWorkList, RequestSize As Integer, CompletionRoutine As DkmCompletionRoutine(Of DkmGetNextFramesAsyncResult))

Parameters

WorkList
DkmWorkList

WorkList to append the new work item to.

RequestSize
Int32

[In] RequestSize is the number of frames that the caller would like returned. The implementation of GetNextFrames may return fewer frames in the case that stack does not contain that many frames. Negative values, or request to read more than MaxFrames (currently 5,000) will be capped to MaxFrames.

CompletionRoutine
DkmCompletionRoutine<DkmGetNextFramesAsyncResult>

Routine to fire when the request is complete. If the request is successfully appended to the work list, this will always fire (including when the operation is canceled). This will never fire if appending the work item fails.

Applies to