DkmRuntimeHardwareDataBreakpoint.Create Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Breakpoints

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Creates a new DkmRuntimeHardwareDataBreakpoint object. After creation, the breakpoint is in the disabled state, and must be explicitly enabled. The caller is responsible for closing the created object after they are done.

public:
 static Microsoft::VisualStudio::Debugger::Breakpoints::DkmRuntimeHardwareDataBreakpoint ^ Create(Microsoft::VisualStudio::Debugger::DkmRuntimeInstance ^ RuntimeInstance, Guid SourceId, Microsoft::VisualStudio::Debugger::DkmThread ^ Thread, System::UInt64 Address, Microsoft::VisualStudio::Debugger::Breakpoints::DkmDataAccessStopMask Access, int Size, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Breakpoints.DkmRuntimeHardwareDataBreakpoint Create (Microsoft.VisualStudio.Debugger.DkmRuntimeInstance RuntimeInstance, Guid SourceId, Microsoft.VisualStudio.Debugger.DkmThread? Thread, ulong Address, Microsoft.VisualStudio.Debugger.Breakpoints.DkmDataAccessStopMask Access, int Size, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.DkmRuntimeInstance * Guid * Microsoft.VisualStudio.Debugger.DkmThread * uint64 * Microsoft.VisualStudio.Debugger.Breakpoints.DkmDataAccessStopMask * int * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Breakpoints.DkmRuntimeHardwareDataBreakpoint

Public Shared Function Create (RuntimeInstance As DkmRuntimeInstance, SourceId As Guid, Thread As DkmThread, Address As ULong, Access As DkmDataAccessStopMask, Size As Integer, DataItem As DkmDataItem) As DkmRuntimeHardwareDataBreakpoint

Parameters

RuntimeInstance

DkmRuntimeInstance

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

SourceId

Guid

[In] Identifies the source of an object. SourceIds are used to enable filtering in scenarios when multiple components may be creating instances of a class. For example, source ids can be used to determine if a breakpoint comes from the AD7 AL (ex: user breakpoint, or other breakpoint visible at the SDM level) instead of a breakpoint which may be created by another component (for example an internal breakpoint used for stepping).

Thread

DkmThread

[In,Optional] Thread on which this breakpoint should fire. If null, the breakpoint will fire on all threads.

Address

UInt64

[In] Address to stop on. This address must be suitably aligned to match the Size parameter (example: if Size is 4, Address must be a multiple of 4).

Access

DkmDataAccessStopMask

[In] Mask of reasons why the data breakpoint should fire. For example, if 'Write' is set, then the breakpoint will fire when the memory location is written.

Size

Int32

[In] Specifies the size of the location, in bytes, to monitor for access. On an x86-based processor, this parameter can be 1, 2, or 4. However, if Access is DkmDataAccessStopMask.Execute, Size must be 1. On an x64-based processor, this parameter can be 1, 2, 4, or 8. However, if Access equals Access is DkmDataAccessStopMask.Execute, Size must be 1. On an Itanium-based processor, this parameter can be any power of 2, from 1 to 0x80000000.

DataItem

DkmDataItem

[In,Optional] Data object to add to the new DkmRuntimeHardwareDataBreakpoint instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmRuntimeHardwareDataBreakpoint

[Out] Result of this method call.