DkmRuntimeClrDataBreakpoint.Create Method

  • Reference

Definition

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

Creates a new DkmRuntimeClrDataBreakpoint 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.

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

public:
 static Microsoft::VisualStudio::Debugger::Breakpoints::DkmRuntimeClrDataBreakpoint ^ Create(Guid SourceId, Microsoft::VisualStudio::Debugger::DkmThread ^ Thread, Microsoft::VisualStudio::Debugger::Clr::DkmClrRuntimeInstance ^ RuntimeInstance, Microsoft::VisualStudio::Debugger::Breakpoints::DkmDataAccessStopMask Access, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);
public static Microsoft.VisualStudio.Debugger.Breakpoints.DkmRuntimeClrDataBreakpoint Create (Guid SourceId, Microsoft.VisualStudio.Debugger.DkmThread Thread, Microsoft.VisualStudio.Debugger.Clr.DkmClrRuntimeInstance RuntimeInstance, Microsoft.VisualStudio.Debugger.Breakpoints.DkmDataAccessStopMask Access, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);
public static Microsoft.VisualStudio.Debugger.Breakpoints.DkmRuntimeClrDataBreakpoint Create (Guid SourceId, Microsoft.VisualStudio.Debugger.DkmThread? Thread, Microsoft.VisualStudio.Debugger.Clr.DkmClrRuntimeInstance RuntimeInstance, Microsoft.VisualStudio.Debugger.Breakpoints.DkmDataAccessStopMask Access, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);
static member Create : Guid * Microsoft.VisualStudio.Debugger.DkmThread * Microsoft.VisualStudio.Debugger.Clr.DkmClrRuntimeInstance * Microsoft.VisualStudio.Debugger.Breakpoints.DkmDataAccessStopMask * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Breakpoints.DkmRuntimeClrDataBreakpoint
Public Shared Function Create (SourceId As Guid, Thread As DkmThread, RuntimeInstance As DkmClrRuntimeInstance, Access As DkmDataAccessStopMask, DataItem As DkmDataItem) As DkmRuntimeClrDataBreakpoint

Parameters

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.

RuntimeInstance
DkmClrRuntimeInstance

[In] Represents a CLR instance running in a target process.

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.

DataItem
DkmDataItem

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

Returns

DkmRuntimeClrDataBreakpoint

[Out] Result of this method call.

Applies to