DkmEvaluationResultEnumContext Class

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Evaluation

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Context object used to enumerate child members of an evaluation result, or to enumerate local variables from a stack frame. This is logically similar to an enumerator, except that access to elements is index-based rather than sequential.

public ref class DkmEvaluationResultEnumContext : Microsoft::VisualStudio::Debugger::DkmDataContainer, IDisposable

[System.Runtime.InteropServices.Guid("8a77c186-e7a6-31bc-b218-d7ea66212f8b")]
public class DkmEvaluationResultEnumContext : Microsoft.VisualStudio.Debugger.DkmDataContainer, IDisposable

[<System.Runtime.InteropServices.Guid("8a77c186-e7a6-31bc-b218-d7ea66212f8b")>]
type DkmEvaluationResultEnumContext = class
    inherit DkmDataContainer
    interface IDisposable

Public Class DkmEvaluationResultEnumContext
Inherits DkmDataContainer
Implements IDisposable

Inheritance

MarshalByRefObject

DkmDataContainer

DkmEvaluationResultEnumContext

Attributes

GuidAttribute

Implements

IDisposable

Properties

Count	The number of items (DkmEvaluationResults) which can be obtained through this DkmEvaluationResultEnumContext.
InspectionContext	Inspection context used to create this enumeration context.
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.
RuntimeInstance	Indicates which runtime monitor will be used to perform this evaluation.
StackFrame	The stack frame this expression result was created on.
UniqueId	Guid which uniquely identifies this enumeration context.

Methods

Close()	Closes the enum context object to release the resources associated with it. This method must be invoked by the component which initiated the enumeration (ex: called DkmEvaluationResult.GetChildren or DkmInspectionContext.GetFrameLocals). DkmEvaluationResultEnumContext objects are automatically closed when their associated DkmInspectionSession object is closed.
Create(Int32, DkmStackWalkFrame, DkmInspectionContext, DkmDataItem)	Create a new DkmEvaluationResultEnumContext object instance.
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)
GetItems(DkmWorkList, Int32, Int32, DkmCompletionRoutine<DkmEvaluationEnumAsyncResult>)	Obtain DkmEvaluationResult items from this enumeration context. This is used to obtain local variables of a stack frame or child members from an evaluation result. 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.
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)

Explicit Interface Implementations

IDisposable.Dispose()