DkmRuntimeCustomDataBreakpoint.Create Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Debugger.Breakpoints
Assembly:
Microsoft.VisualStudio.Debugger.Engine.dll

Creates a new DkmRuntimeCustomDataBreakpoint 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::DkmRuntimeCustomDataBreakpoint ^ Create(Microsoft::VisualStudio::Debugger::DkmRuntimeInstance ^ RuntimeInstance, Guid SourceId, Microsoft::VisualStudio::Debugger::DkmThread ^ Thread, System::String ^ Description, Microsoft::VisualStudio::Debugger::Breakpoints::DkmDataAccessStopMask Access, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);
public static Microsoft.VisualStudio.Debugger.Breakpoints.DkmRuntimeCustomDataBreakpoint Create (Microsoft.VisualStudio.Debugger.DkmRuntimeInstance RuntimeInstance, Guid SourceId, Microsoft.VisualStudio.Debugger.DkmThread Thread, string Description, Microsoft.VisualStudio.Debugger.Breakpoints.DkmDataAccessStopMask Access, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);
static member Create : Microsoft.VisualStudio.Debugger.DkmRuntimeInstance * Guid * Microsoft.VisualStudio.Debugger.DkmThread * string * Microsoft.VisualStudio.Debugger.Breakpoints.DkmDataAccessStopMask * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Breakpoints.DkmRuntimeCustomDataBreakpoint
Public Shared Function Create (RuntimeInstance As DkmRuntimeInstance, SourceId As Guid, Thread As DkmThread, Description As String, Access As DkmDataAccessStopMask, DataItem As DkmDataItem) As DkmRuntimeCustomDataBreakpoint

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.

Description
String

[In] A description of where/how to set the custom data breakpoint. The format of this string is monitor dependent.

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 DkmRuntimeCustomDataBreakpoint instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmRuntimeCustomDataBreakpoint

[Out] Result of this method call.

Applies to