DkmCompiledInspectionQuery Class

  • Reference

Definition

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

Represents a query which is produced by an expression evaluator or similar component and set to the target computer to obtain information about the dynamic state of the program (ex: the current value of a register). Consumers of inspection queries should call Close() once it is known that the inspection query will no longer execute.

Derived classes: DkmCompiledCustomInspectionQuery, DkmCompiledILInspectionQuery, DkmCompiledClrInspectionQuery, DkmCompiledClrLocalsQuery

public ref class DkmCompiledInspectionQuery abstract
[Windows::Foundation::Metadata::WebHostHidden]
public ref class DkmCompiledInspectionQuery abstract
[Windows::Foundation::Metadata::WebHostHidden]
class DkmCompiledInspectionQuery abstract
[System.Runtime.InteropServices.Guid("47a09cc9-e122-16e1-9132-beda4e7b8025")]
public abstract class DkmCompiledInspectionQuery
[<System.Runtime.InteropServices.Guid("47a09cc9-e122-16e1-9132-beda4e7b8025")>]
type DkmCompiledInspectionQuery = class
Public MustInherit Class DkmCompiledInspectionQuery
Inheritance
Object
DkmCompiledInspectionQuery
Derived
Attributes
GuidAttribute

Properties

DataContainer

[Optional] Custom Data to associate with this inspection query. It will persist as long as the query has the potential to execute.

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

The language of the expression evaluator that created this query.

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

Indicates the type of inspection query. This is used to select a component to process the query.
RuntimeInstance

The DkmRuntimeInstance class represents an execution environment which is loaded into a DkmProcess and which contains code to be debugged.
SourceWorkerProcess

[Optional] If non-null, the worker process where the inspection query was created.

This API was introduced in Visual Studio 16 RTM (DkmApiVersion.VS16RTMPreview).
TagValue

DkmCompiledInspectionQuery is an abstract base class. This enum indicates which derived class this object is an instance of.

Methods

Close()

Closes this compiled inspection query. This should be called at the point in which the query will no longer execute.

This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).
Execute(DkmWorkList, ReadOnlyCollection<DkmILParameterValue>, DkmILContext, UInt32, DkmFuncEvalFlags, DkmCompletionRoutine<DkmExecuteQueryAsyncResult>)

Executes a compiled inspection query and returns any results.

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.
Execute(ReadOnlyCollection<DkmILParameterValue>, DkmILContext, UInt32, DkmFuncEvalFlags, DkmILFailureReason)

Executes a compiled inspection query and returns any results.
ResolveILFailureReason(DkmILFailureReason)

Resolves a DkmILFailureReason into an error message. This is used to produce the error message for a condition breakpoint.

Location constraint: API must be called from an IDE component (component level > 100,000).

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

Applies to