Share via

DkmAsyncStackWalkContext.Create Method

  • Reference

Definition

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

Overloads

Create(DkmInspectionSession, Guid, DkmStackWalkFrame, DkmStackWalkFrame, DkmSuccessEvaluationResult, DkmTask, ReadOnlyCollection<DkmSuccessEvaluationResult>, DkmRuntimeInstance, DkmDataItem)

Create a new DkmAsyncStackWalkContext object instance.

This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).
Create(DkmInspectionSession, Guid, DkmStackWalkFrame, DkmStackWalkFrame, DkmSuccessEvaluationResult, DkmTask, ReadOnlyCollection<DkmSuccessEvaluationResult>, DkmRuntimeInstance, Boolean, DkmDataItem)

Create a new DkmAsyncStackWalkContext object instance.

This API was introduced in Visual Studio 16 Update 7 (DkmApiVersion.VS16Update7).

Create(DkmInspectionSession, Guid, DkmStackWalkFrame, DkmStackWalkFrame, DkmSuccessEvaluationResult, DkmTask, ReadOnlyCollection<DkmSuccessEvaluationResult>, DkmRuntimeInstance, DkmDataItem)

Create a new DkmAsyncStackWalkContext object instance.

This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).

public:
 static Microsoft::VisualStudio::Debugger::CallStack::DkmAsyncStackWalkContext ^ Create(Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionSession ^ InspectionSession, Guid TaskProviderId, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ TaskIdentityStackFrame, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ InternalStackFrame, Microsoft::VisualStudio::Debugger::Evaluation::DkmSuccessEvaluationResult ^ FrameObject, Microsoft::VisualStudio::Debugger::ParallelTasks::DkmTask ^ Task, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::Evaluation::DkmSuccessEvaluationResult ^> ^ ReturnStackFunctions, Microsoft::VisualStudio::Debugger::DkmRuntimeInstance ^ RuntimeInstance, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);
public static Microsoft.VisualStudio.Debugger.CallStack.DkmAsyncStackWalkContext Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession InspectionSession, Guid TaskProviderId, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame TaskIdentityStackFrame, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame InternalStackFrame, Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult FrameObject, Microsoft.VisualStudio.Debugger.ParallelTasks.DkmTask Task, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult> ReturnStackFunctions, Microsoft.VisualStudio.Debugger.DkmRuntimeInstance RuntimeInstance, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);
public static Microsoft.VisualStudio.Debugger.CallStack.DkmAsyncStackWalkContext Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession InspectionSession, Guid TaskProviderId, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame? TaskIdentityStackFrame, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame? InternalStackFrame, Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult? FrameObject, Microsoft.VisualStudio.Debugger.ParallelTasks.DkmTask? Task, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult>? ReturnStackFunctions, Microsoft.VisualStudio.Debugger.DkmRuntimeInstance RuntimeInstance, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);
static member Create : Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession * Guid * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult * Microsoft.VisualStudio.Debugger.ParallelTasks.DkmTask * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult> * Microsoft.VisualStudio.Debugger.DkmRuntimeInstance * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.CallStack.DkmAsyncStackWalkContext
Public Shared Function Create (InspectionSession As DkmInspectionSession, TaskProviderId As Guid, TaskIdentityStackFrame As DkmStackWalkFrame, InternalStackFrame As DkmStackWalkFrame, FrameObject As DkmSuccessEvaluationResult, Task As DkmTask, ReturnStackFunctions As ReadOnlyCollection(Of DkmSuccessEvaluationResult), RuntimeInstance As DkmRuntimeInstance, DataItem As DkmDataItem) As DkmAsyncStackWalkContext

Parameters

InspectionSession
DkmInspectionSession

[In] The inspection session that owns this task object.

TaskProviderId
Guid

[In] Extensible GUID indicating the task provider which a task is from.

TaskIdentityStackFrame
DkmStackWalkFrame

[In,Optional] If this stack walk context refers to a task that is associated with a particular stack frame, specifies the stack frame that this task object is associated with.

InternalStackFrame
DkmStackWalkFrame

[In,Optional] Internal stack frame used to perform inspection operations on async frames in the return stack, for example, the CLR requires an ICorDebugFrame to read static fields.

FrameObject
DkmSuccessEvaluationResult

[In,Optional] Optional evaluation result representing the frame that this stack walk context refers to. When C++ debugging, this is used to support inspection inside of return stack frames.

Task
DkmTask

[In,Optional] Optional task to use for inspection of async frames.

ReturnStackFunctions
ReadOnlyCollection<DkmSuccessEvaluationResult>

[In,Optional] For native async frames, specifies an list of available functions in the return stack, from which captured local variables may be extracted from. Null for managed and JavaScript.

RuntimeInstance
DkmRuntimeInstance

[In] The runtime instance associated with this task object.

DataItem
DkmDataItem

[In,Optional] Data object to add to the new DkmAsyncStackWalkContext instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmAsyncStackWalkContext

[Out] Result of this method call.

Applies to

Create(DkmInspectionSession, Guid, DkmStackWalkFrame, DkmStackWalkFrame, DkmSuccessEvaluationResult, DkmTask, ReadOnlyCollection<DkmSuccessEvaluationResult>, DkmRuntimeInstance, Boolean, DkmDataItem)

Create a new DkmAsyncStackWalkContext object instance.

This API was introduced in Visual Studio 16 Update 7 (DkmApiVersion.VS16Update7).

public:
 static Microsoft::VisualStudio::Debugger::CallStack::DkmAsyncStackWalkContext ^ Create(Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionSession ^ InspectionSession, Guid TaskProviderId, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ TaskIdentityStackFrame, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ InternalStackFrame, Microsoft::VisualStudio::Debugger::Evaluation::DkmSuccessEvaluationResult ^ FrameObject, Microsoft::VisualStudio::Debugger::ParallelTasks::DkmTask ^ Task, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::Evaluation::DkmSuccessEvaluationResult ^> ^ ReturnStackFunctions, Microsoft::VisualStudio::Debugger::DkmRuntimeInstance ^ RuntimeInstance, bool CurrentTaskOnly, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);
public static Microsoft.VisualStudio.Debugger.CallStack.DkmAsyncStackWalkContext Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession InspectionSession, Guid TaskProviderId, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame TaskIdentityStackFrame, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame InternalStackFrame, Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult FrameObject, Microsoft.VisualStudio.Debugger.ParallelTasks.DkmTask Task, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult> ReturnStackFunctions, Microsoft.VisualStudio.Debugger.DkmRuntimeInstance RuntimeInstance, bool CurrentTaskOnly, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);
public static Microsoft.VisualStudio.Debugger.CallStack.DkmAsyncStackWalkContext Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession InspectionSession, Guid TaskProviderId, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame? TaskIdentityStackFrame, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame? InternalStackFrame, Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult? FrameObject, Microsoft.VisualStudio.Debugger.ParallelTasks.DkmTask? Task, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult>? ReturnStackFunctions, Microsoft.VisualStudio.Debugger.DkmRuntimeInstance RuntimeInstance, bool CurrentTaskOnly, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);
static member Create : Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession * Guid * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult * Microsoft.VisualStudio.Debugger.ParallelTasks.DkmTask * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult> * Microsoft.VisualStudio.Debugger.DkmRuntimeInstance * bool * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.CallStack.DkmAsyncStackWalkContext
Public Shared Function Create (InspectionSession As DkmInspectionSession, TaskProviderId As Guid, TaskIdentityStackFrame As DkmStackWalkFrame, InternalStackFrame As DkmStackWalkFrame, FrameObject As DkmSuccessEvaluationResult, Task As DkmTask, ReturnStackFunctions As ReadOnlyCollection(Of DkmSuccessEvaluationResult), RuntimeInstance As DkmRuntimeInstance, CurrentTaskOnly As Boolean, DataItem As DkmDataItem) As DkmAsyncStackWalkContext

Parameters

InspectionSession
DkmInspectionSession

[In] The inspection session that owns this task object.

TaskProviderId
Guid

[In] Extensible GUID indicating the task provider which a task is from.

TaskIdentityStackFrame
DkmStackWalkFrame

[In,Optional] If this stack walk context refers to a task that is associated with a particular stack frame, specifies the stack frame that this task object is associated with.

InternalStackFrame
DkmStackWalkFrame

[In,Optional] Internal stack frame used to perform inspection operations on async frames in the return stack, for example, the CLR requires an ICorDebugFrame to read static fields.

FrameObject
DkmSuccessEvaluationResult

[In,Optional] Optional evaluation result representing the frame that this stack walk context refers to. When C++ debugging, this is used to support inspection inside of return stack frames.

Task
DkmTask

[In,Optional] Optional task to use for inspection of async frames.

ReturnStackFunctions
ReadOnlyCollection<DkmSuccessEvaluationResult>

[In,Optional] For native async frames, specifies an list of available functions in the return stack, from which captured local variables may be extracted from. Null for managed and JavaScript.

RuntimeInstance
DkmRuntimeInstance

[In] The runtime instance associated with this task object.

CurrentTaskOnly
Boolean

[In] Get only the stack frames for the context's task rather than the full async stack .

DataItem
DkmDataItem

[In,Optional] Data object to add to the new DkmAsyncStackWalkContext instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmAsyncStackWalkContext

[Out] Result of this method call.

Applies to