DkmPendingFunctionBreakpoint.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 pending breakpoint object. After creation, the returned object will still be disabled and will not be tracked by the breakpoint manager. To complete initialization, the caller should set additional properties on the breakpoint and 'Enable' or 'Enroll' it. The caller is responsible for closing the created object after they are done.

public:
 static Microsoft::VisualStudio::Debugger::Breakpoints::DkmPendingFunctionBreakpoint ^ Create(Microsoft::VisualStudio::Debugger::DkmProcess ^ Process, Guid SourceId, Microsoft::VisualStudio::Debugger::Evaluation::DkmCompilerId CompilerId, Microsoft::VisualStudio::Debugger::DkmThread ^ Thread, bool IsBarrier, System::String ^ ModuleName, System::String ^ FunctionName, System::UInt32 LineOffset, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Breakpoints.DkmPendingFunctionBreakpoint Create (Microsoft.VisualStudio.Debugger.DkmProcess Process, Guid SourceId, Microsoft.VisualStudio.Debugger.Evaluation.DkmCompilerId CompilerId, Microsoft.VisualStudio.Debugger.DkmThread? Thread, bool IsBarrier, string? ModuleName, string FunctionName, uint LineOffset, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.DkmProcess * Guid * Microsoft.VisualStudio.Debugger.Evaluation.DkmCompilerId * Microsoft.VisualStudio.Debugger.DkmThread * bool * string * string * uint32 * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Breakpoints.DkmPendingFunctionBreakpoint

Public Shared Function Create (Process As DkmProcess, SourceId As Guid, CompilerId As DkmCompilerId, Thread As DkmThread, IsBarrier As Boolean, ModuleName As String, FunctionName As String, LineOffset As UInteger, DataItem As DkmDataItem) As DkmPendingFunctionBreakpoint

Parameters

Process

DkmProcess

[In] 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.

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).

CompilerId

DkmCompilerId

[In] Identifies the source language (ex: C#) and compiler vendor (ex: Microsoft) that the breakpoint should bind against. 'LanguageId' may be left as Guid.Empty to indicate that the breakpoint should bind against all languages. 'VendorId' is nearly always left as Guid.Empty, which indicates that only the language is known (not the compiler).

Thread

DkmThread

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

IsBarrier

Boolean

[In] Indicates if this breakpoint is a barrier that should be set on the hardware, this works for GPU debugging.

ModuleName

String

[In,Optional] Name of the module to search for the breakpoint. If null, all modules will be searched.

FunctionName

String

[In] Name of the function to bind to.

LineOffset

UInt32

[In] The line of the function to bind to.

DataItem

DkmDataItem

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

Returns

DkmPendingFunctionBreakpoint

[Out] Result of this method call.