Share via

DkmClrValue.GetResult Method

  • Reference

Definition

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

Format a DkmClrValue and return a DkmEvaluationResult.

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 a Monitor component (component level < 100,000).

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

public:
 void GetResult(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, Microsoft::VisualStudio::Debugger::Clr::DkmClrType ^ DeclaredType, Microsoft::VisualStudio::Debugger::Evaluation::ClrCompilation::DkmClrCustomTypeInfo ^ CustomTypeInfo, Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionContext ^ InspectionContext, System::Collections::ObjectModel::ReadOnlyCollection<System::String ^> ^ FormatSpecifiers, System::String ^ ResultName, System::String ^ ResultFullName, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::Evaluation::ClrCompilation::DkmEvaluationAsyncResult> ^ CompletionRoutine);
public void GetResult (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.Clr.DkmClrType DeclaredType, Microsoft.VisualStudio.Debugger.Evaluation.ClrCompilation.DkmClrCustomTypeInfo CustomTypeInfo, Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, System.Collections.ObjectModel.ReadOnlyCollection<string> FormatSpecifiers, string ResultName, string ResultFullName, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Evaluation.ClrCompilation.DkmEvaluationAsyncResult> CompletionRoutine);
public void GetResult (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.Clr.DkmClrType? DeclaredType, Microsoft.VisualStudio.Debugger.Evaluation.ClrCompilation.DkmClrCustomTypeInfo? CustomTypeInfo, Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, System.Collections.ObjectModel.ReadOnlyCollection<string>? FormatSpecifiers, string ResultName, string? ResultFullName, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Evaluation.ClrCompilation.DkmEvaluationAsyncResult> CompletionRoutine);
member this.GetResult : Microsoft.VisualStudio.Debugger.DkmWorkList * Microsoft.VisualStudio.Debugger.Clr.DkmClrType * Microsoft.VisualStudio.Debugger.Evaluation.ClrCompilation.DkmClrCustomTypeInfo * Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext * System.Collections.ObjectModel.ReadOnlyCollection<string> * string * string * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Evaluation.ClrCompilation.DkmEvaluationAsyncResult> -> unit
Public Sub GetResult (WorkList As DkmWorkList, DeclaredType As DkmClrType, CustomTypeInfo As DkmClrCustomTypeInfo, InspectionContext As DkmInspectionContext, FormatSpecifiers As ReadOnlyCollection(Of String), ResultName As String, ResultFullName As String, CompletionRoutine As DkmCompletionRoutine(Of DkmEvaluationAsyncResult))

Parameters

WorkList
DkmWorkList

WorkList to append the new work item to.

DeclaredType
DkmClrType

[In,Optional] The declared type if it is different from the runtime type.

CustomTypeInfo
DkmClrCustomTypeInfo

[In,Optional] The optional information provided by the expression compiler for identifying compiler intrinsic type information.

InspectionContext
DkmInspectionContext

[In] The inspection context for this evaluation.

FormatSpecifiers
ReadOnlyCollection<String>

[In,Optional] The optional format specifier(s) to use when formatting this result.

ResultName
String

[In] The name of this result. This value is typically the expression being evaluated.

ResultFullName
String

[In,Optional] The full name of this result. This is the expression added to the Watch window if the user selects "Add to Watch".

CompletionRoutine
DkmCompletionRoutine<DkmEvaluationAsyncResult>

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