DkmInstructionAddress Class

Definition

Namespace:

Microsoft.VisualStudio.Debugger

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Abstract representation of an executable code location (ex: EIP value). If resolved, an Instruction Address will be within a particular module instance. An Instruction Address is always within a particular Runtime Instance.

Derived classes: DkmClrInstructionAddress, DkmClrNcInstructionAddress, DkmCustomInstructionAddress, DkmNativeInstructionAddress, DkmScriptInstructionAddress, DkmUnknownInstructionAddress

public ref class DkmInstructionAddress abstract

[Windows::Foundation::Metadata::WebHostHidden]
public ref class DkmInstructionAddress abstract

[Windows::Foundation::Metadata::WebHostHidden]
class DkmInstructionAddress abstract

[System.Runtime.InteropServices.Guid("6e2a219f-3a14-3410-e755-d00ce1f2f5e6")]
public abstract class DkmInstructionAddress

[<System.Runtime.InteropServices.Guid("6e2a219f-3a14-3410-e755-d00ce1f2f5e6")>]
type DkmInstructionAddress = class

Public MustInherit Class DkmInstructionAddress

Inheritance

Object

DkmInstructionAddress

Derived

Microsoft.VisualStudio.Debugger.Clr.DkmClrInstructionAddress

Microsoft.VisualStudio.Debugger.CustomRuntimes.DkmCustomInstructionAddress

Microsoft.VisualStudio.Debugger.DkmUnknownInstructionAddress

Microsoft.VisualStudio.Debugger.Native.DkmNativeInstructionAddress

Microsoft.VisualStudio.Debugger.Script.DkmScriptInstructionAddress

Attributes

GuidAttribute

Properties

CPUInstructionPart	[Optional] CPUInstructionPart provides the address that the CPU will execute. This is always provided for native instructions. It may be provided for CLR or custom addresses depending on how the address object was created.
ModuleInstance	[Optional] The module containing this address. Addresses without a module cannot have symbols (even for custom addresses). CLR addresses will always have a module. Native addresses will not have a module if either the CPU jumped to an invalid address (ex: NULL), or if the CPU is executing dynamically-emitted code.
Process	DkmProcess represents a target process which is being debugged. The debugger debugs processes, so this is the basic unit of debugging. A DkmProcess can represent a system process or a virtual process such as minidumps.
RuntimeInstance	The DkmRuntimeInstance class represents an execution environment which is loaded into a DkmProcess and which contains code to be debugged.
TagValue	DkmInstructionAddress is an abstract base class. This enum indicates which derived class this object is an instance of.

Methods

CompareTo(DkmInstructionAddress)	Compares two instruction addresses and returns a value indicating whether one is less than, equal to, or greater than the other. The addresses must be from the same module.
GetCurrentCPUAddress()	Resolves a DkmInstructionAddress to a CPU InstructionAddress. This is the reverse mapping of ResolveCPUInstructionAddress. This API is currently only supported by CLR DkmRuntimeInstance objects. Location constraint: This API should generally be called on the client, but it can be called on the server for translating CLR addresses (but not native-compiled).
GetCurrentCPUAddress(DkmWorkList, DkmCompletionRoutine<DkmGetCurrentCPUAddressAsyncResult>)	Resolves a DkmInstructionAddress to a CPU InstructionAddress. This is the reverse mapping of ResolveCPUInstructionAddress. This API is currently only supported by CLR DkmRuntimeInstance objects. 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: This API should generally be called on the client, but it can be called on the server for translating CLR addresses (but not native-compiled).
GetSymbol()	Convert a DkmInstructionAddress into a DkmInstructionSymbol. If the DkmInstructionAddress is not in a DkmModule then GetSymbol will return null (S_FALSE in native code).
IsInSameFunction(DkmInstructionAddress)	Compares two instruction addresses and determines if they are within the same function. Location constraint: API must be called from an IDE component (component level > 100,000).
IsUserCode(DkmWorkList, DkmCompletionRoutine<DkmIsUserCodeAsyncResult>)	Determines if a given instruction address is user code or not. 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: Note: with Visual Studio 2017 Update 8, the CallDirection of the API was made 'Bidirectional' from 'Normal' and can now be called from any component. This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).