DkmRootVisualizedExpression.Create Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Evaluation

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Overloads

Create(DkmInspectionContext, Guid, Guid, DkmStackWalkFrame, DkmExpressionValueHome, DkmModule, String, String, DkmRootVisualizedExpressionFlags, UInt32, DkmDataItem)	Create a new DkmRootVisualizedExpression object instance.
Create(DkmInspectionContext, Guid, Guid, DkmStackWalkFrame, DkmExpressionValueHome, DkmModule, String, String, DkmRootVisualizedExpressionFlags, UInt32, String, DkmDataItem)	Create a new DkmRootVisualizedExpression object instance. This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

Create(DkmInspectionContext, Guid, Guid, DkmStackWalkFrame, DkmExpressionValueHome, DkmModule, String, String, DkmRootVisualizedExpressionFlags, UInt32, DkmDataItem)

Create a new DkmRootVisualizedExpression object instance.

public:
 static Microsoft::VisualStudio::Debugger::Evaluation::DkmRootVisualizedExpression ^ Create(Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionContext ^ InspectionContext, Guid VisualizerId, Guid SourceId, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ StackFrame, Microsoft::VisualStudio::Debugger::Evaluation::DkmExpressionValueHome ^ ValueHome, Microsoft::VisualStudio::Debugger::Symbols::DkmModule ^ Module, System::String ^ Name, System::String ^ FullName, Microsoft::VisualStudio::Debugger::Evaluation::DkmRootVisualizedExpressionFlags Flags, System::UInt32 ArrayLength, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Evaluation.DkmRootVisualizedExpression Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, Guid VisualizerId, Guid SourceId, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame StackFrame, Microsoft.VisualStudio.Debugger.Evaluation.DkmExpressionValueHome? ValueHome, Microsoft.VisualStudio.Debugger.Symbols.DkmModule? Module, string Name, string FullName, Microsoft.VisualStudio.Debugger.Evaluation.DkmRootVisualizedExpressionFlags Flags, uint ArrayLength, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext * Guid * Guid * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * Microsoft.VisualStudio.Debugger.Evaluation.DkmExpressionValueHome * Microsoft.VisualStudio.Debugger.Symbols.DkmModule * string * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmRootVisualizedExpressionFlags * uint32 * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Evaluation.DkmRootVisualizedExpression

Public Shared Function Create (InspectionContext As DkmInspectionContext, VisualizerId As Guid, SourceId As Guid, StackFrame As DkmStackWalkFrame, ValueHome As DkmExpressionValueHome, Module As DkmModule, Name As String, FullName As String, Flags As DkmRootVisualizedExpressionFlags, ArrayLength As UInteger, DataItem As DkmDataItem) As DkmRootVisualizedExpression

Parameters

InspectionContext

DkmInspectionContext

[In] Options and target context to use while performing the inspection operation.

VisualizerId

Guid

[In] Guid which ties together the addin and the expressions that call that addin. The addin should use the Guid provided in the native visualizer file as a filter.

SourceId

Guid

[In] Guid which ties together the expression evaluator that created this object and the object itself. Generally used by expression evaluators to filter their implementation of IDkmCustomVisualizerCallback to only DkmVisualizedExpression they created.

StackFrame

DkmStackWalkFrame

[In] Stack frame the expression is being evaluated in expression in.

ValueHome

DkmExpressionValueHome

[In,Optional] The location at which the value is stored, which can be modified to edit the value. This should be null for read-only values, such as integer constants.

Module

DkmModule

[In,Optional] The module that contains the type symbol.

Name

String

[In] The name of the expression up to the root node. Addins can choose to use this name or construct their own.

FullName

String

[In] The full name of the expression up to the root node. Addins can choose to use this full name or construct their own. However, if the addin uses a different full name, it must be parsed by the expression evaluator.

Flags

DkmRootVisualizedExpressionFlags

[In] Flags the expression evaluator passes to the visualizer addin describing the value in question. For instance, this will include if the object is a pointer or if it is a reference.

ArrayLength

UInt32

[In] Deprecated: no longer used.

DataItem

DkmDataItem

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

Returns

DkmRootVisualizedExpression

[Out] Result of this method call.

Create(DkmInspectionContext, Guid, Guid, DkmStackWalkFrame, DkmExpressionValueHome, DkmModule, String, String, DkmRootVisualizedExpressionFlags, UInt32, String, DkmDataItem)

Create a new DkmRootVisualizedExpression object instance.

This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

public:
 static Microsoft::VisualStudio::Debugger::Evaluation::DkmRootVisualizedExpression ^ Create(Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionContext ^ InspectionContext, Guid VisualizerId, Guid SourceId, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ StackFrame, Microsoft::VisualStudio::Debugger::Evaluation::DkmExpressionValueHome ^ ValueHome, Microsoft::VisualStudio::Debugger::Symbols::DkmModule ^ Module, System::String ^ Name, System::String ^ FullName, Microsoft::VisualStudio::Debugger::Evaluation::DkmRootVisualizedExpressionFlags Flags, System::UInt32 ArrayLength, System::String ^ Type, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Evaluation.DkmRootVisualizedExpression Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, Guid VisualizerId, Guid SourceId, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame StackFrame, Microsoft.VisualStudio.Debugger.Evaluation.DkmExpressionValueHome? ValueHome, Microsoft.VisualStudio.Debugger.Symbols.DkmModule? Module, string Name, string FullName, Microsoft.VisualStudio.Debugger.Evaluation.DkmRootVisualizedExpressionFlags Flags, uint ArrayLength, string? Type, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext * Guid * Guid * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * Microsoft.VisualStudio.Debugger.Evaluation.DkmExpressionValueHome * Microsoft.VisualStudio.Debugger.Symbols.DkmModule * string * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmRootVisualizedExpressionFlags * uint32 * string * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Evaluation.DkmRootVisualizedExpression

Public Shared Function Create (InspectionContext As DkmInspectionContext, VisualizerId As Guid, SourceId As Guid, StackFrame As DkmStackWalkFrame, ValueHome As DkmExpressionValueHome, Module As DkmModule, Name As String, FullName As String, Flags As DkmRootVisualizedExpressionFlags, ArrayLength As UInteger, Type As String, DataItem As DkmDataItem) As DkmRootVisualizedExpression

Parameters

InspectionContext

DkmInspectionContext

[In] Options and target context to use while performing the inspection operation.

VisualizerId

Guid

[In] Guid which ties together the addin and the expressions that call that addin. The addin should use the Guid provided in the native visualizer file as a filter.

SourceId

Guid

[In] Guid which ties together the expression evaluator that created this object and the object itself. Generally used by expression evaluators to filter their implementation of IDkmCustomVisualizerCallback to only DkmVisualizedExpression they created.

StackFrame

DkmStackWalkFrame

[In] Stack frame the expression is being evaluated in expression in.

ValueHome

DkmExpressionValueHome

[In,Optional] The location at which the value is stored, which can be modified to edit the value. This should be null for read-only values, such as integer constants.

Module

DkmModule

[In,Optional] The module that contains the type symbol.

Name

String

[In] The name of the expression up to the root node. Addins can choose to use this name or construct their own.

FullName

String

[In] The full name of the expression up to the root node. Addins can choose to use this full name or construct their own. However, if the addin uses a different full name, it must be parsed by the expression evaluator.

Flags

DkmRootVisualizedExpressionFlags

[In] Flags the expression evaluator passes to the visualizer addin describing the value in question. For instance, this will include if the object is a pointer or if it is a reference.

ArrayLength

UInt32

[In] Deprecated: no longer used.

Type

String

[In,Optional] The type of the object being inspected. This is often the same type that is being referred to by the natvis entry that triggered the addin. However, it can also be a pointer or reference to the type, or even a base or derived class of the type. The addin should make no assumptions about what is in this string and should not attempt to parse it to obtain information about the object. Most addins should pass this string along through, as is to the 'Type' property of the evaluation result they create. However, an addin may choose to add additional annotations to the 'Type' string before returning it back. Except for a hint of what to put in the 'Type' field of the result, this string is irrelevant to the visualization of the object. Regardless of whether the original object is a pointer, reference, base type, or derived type, the supplied DkmExpressionValueHome will always identify the location of the object itself, never a pointer or reference to the object. An empty type string may be passed in here if the type of the evaluation result does not matter for the scenario in which the visualizer is being invoked.

DataItem

DkmDataItem

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

Returns

DkmRootVisualizedExpression

[Out] Result of this method call.