DkmEvaluationResult Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Debugger.Evaluation

Assembly:: Microsoft.VisualStudio.Debugger.Engine.dll

Package:: Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The formatted result of an evaluation, ready to be displayed in an expression evaluation window.

Derived classes: DkmSuccessEvaluationResult, DkmFailedEvaluationResult, DkmIntermediateEvaluationResult

public ref class DkmEvaluationResult abstract : Microsoft::VisualStudio::Debugger::DkmDataContainer, IDisposable

[System.Runtime.InteropServices.Guid("a017f790-1e94-73fc-a4b5-53278ec5548b")]
public abstract class DkmEvaluationResult : Microsoft.VisualStudio.Debugger.DkmDataContainer, IDisposable

[<System.Runtime.InteropServices.Guid("a017f790-1e94-73fc-a4b5-53278ec5548b")>]
type DkmEvaluationResult = class
    inherit DkmDataContainer
    interface IDisposable

Public MustInherit Class DkmEvaluationResult
Inherits DkmDataContainer
Implements IDisposable

Inheritance: MarshalByRefObject

DkmDataContainer
DkmEvaluationResult

Inheritance: Object

DkmDataContainer
DkmEvaluationResult

Derived: Microsoft.VisualStudio.Debugger.Evaluation.DkmFailedEvaluationResult

Microsoft.VisualStudio.Debugger.Evaluation.DkmIntermediateEvaluationResult

Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult

Attributes: GuidAttribute

Implements: IDisposable

Properties

FullName	[Optional] The full name of the expression this result applies to. This value is used to allow child elements to be added to the watch window (Add Watch from the context menu), and to refresh parts of the evaluation tree. As an example of how FullName differs from name, the name of the 0th element of an array in C++ is '[0]' while the full name would by 'myArrayVariable[0]'. For Visual Studio 14 and later it's possible to calculate the full name later if needed. To do this, the expression evaluator should create the DkmEvaluationResult with a null full name and implement IDkmFullNameProvider. Concord will then call IDkmFullNameProvider.CalculateFullName to get the full name when needed in the UI.
InspectionContext	Inspection context used to create this evaluation result.
InspectionSession	The InspectionSession allows the various components which examine data in the target process to store private data with the same lifetime. Inspection sessions are closed when the user attempts to continue the process.
IsUnloaded	Returns true if a 'unloaded' event has been raised for this object (example: DkmThread::Unload is called) or if the object has been closed. Note that care must be used when checking this status as, without synchronization, the returned status may no longer be accurate the instruction after it is read. (Inherited from DkmDataContainer)
Language	Language used to perform inspections.
Name	The name of the expression this result applies to.
RuntimeInstance	Indicates which runtime monitor will be used to perform this evaluation.
StackFrame	The stack frame this expression result was created on.
TagValue	DkmEvaluationResult is an abstract base class. This enum indicates which derived class this object is an instance of.
UniqueId	Guid which uniquely identifies this evaluation result.

Methods

Close()	Closes the evaluation result object to release the resources associated with it. This method must be invoked by the component which initiated the enumeration (ex: called DkmInspectionContext.EvaluateExpression, DkmEvaluationResultEnumContext.GetItems, etc). DkmEvaluationResult objects are automatically closed when their associated DkmInspectionSession object is closed.
CreateObjectId()	Creates an object id for this particular expression. Location constraint: IDE components may call this method regardless of what type of code is being debugged. This method is also currently supported for debug monitor components, when debugging code running under the CLR; however this functionality may be removed in a future version.
DestroyObjectId()	Destroys an object id for this particular expression. Location constraint: IDE components may call this method regardless of what type of code is being debugged. This method is also currently supported for debug monitor components, when debugging code running under the CLR; however this functionality may be removed in a future version.
GetChildren(DkmWorkList, Int32, DkmInspectionContext, DkmCompletionRoutine<DkmGetChildrenAsyncResult>)	Gets an enumeration context used to obtain the children of this evaluation result. This is used in all expression evaluation windows. 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: IDE components may call this method regardless of what type of code is being debugged. This method is also currently supported for debug monitor components, when debugging code running under the CLR; however this functionality may be removed in a future version.
GetDataItem<T>()	Gets the instance of 'T' which has been added to this container instance. If this container does not contain a 'T', this function will return null. (Inherited from DkmDataContainer)
GetUnderlyingString()	This method is used for evaluation results that include DkmEvaluationResultFlags.RawString to obtain the the underlying string, with no enclosing quotes or escape sequences. This is method is invoked to display one of the various string visualizers in an expression evaluation window (click the magnifying glass icon). Location constraint: IDE components may call this method regardless of what type of code is being debugged. This method is also currently supported for debug monitor components, when debugging code running under the CLR; however this functionality may be removed in a future version.
RemoveDataItem<T>()	Remove the instance of 'T' from this container. It is usually unnecessary to call this method as a data container will automatically be emptied when the object is closed. (Inherited from DkmDataContainer)
SetDataItem<T>(DkmDataCreationDisposition, T)	Place a new item in the data container. (Inherited from DkmDataContainer)
SetValueAsString(String, Int32, String)	Modifies the value of the given evaluation result (assumed to be non-read-only) to match the given string. This is used after the user edits a value in any of the evaluation windows. Location constraint: IDE components may call this method regardless of what type of code is being debugged. This method is also currently supported for debug monitor components, when debugging code running under the CLR; however this functionality may be removed in a future version.

Explicit Interface Implementations

IDisposable.Dispose()

Applies to

Share via