Breakpoints.Add Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Creates and enables a new breakpoint.
[System.Runtime.InteropServices.DispId(4)]
public EnvDTE.Breakpoints Add (string Function = "", string File = "", int Line = 1, int Column = 1, string Condition = "", EnvDTE.dbgBreakpointConditionType ConditionType = EnvDTE.dbgBreakpointConditionType.dbgBreakpointConditionTypeWhenTrue, string Language = "", string Data = "", int DataCount = 1, string Address = "", int HitCount = 0, EnvDTE.dbgHitCountType HitCountType = EnvDTE.dbgHitCountType.dbgHitCountTypeNone);[<System.Runtime.InteropServices.DispId(4)>]
abstract member Add : string * string * int * int * string * EnvDTE.dbgBreakpointConditionType * string * string * int * string * int * EnvDTE.dbgHitCountType -> EnvDTE.BreakpointsPublic Function Add (Optional Function As String = "", Optional File As String = "", Optional Line As Integer = 1, Optional Column As Integer = 1, Optional Condition As String = "", Optional ConditionType As dbgBreakpointConditionType = EnvDTE.dbgBreakpointConditionType.dbgBreakpointConditionTypeWhenTrue, Optional Language As String = "", Optional Data As String = "", Optional DataCount As Integer = 1, Optional Address As String = "", Optional HitCount As Integer = 0, Optional HitCountType As dbgHitCountType = EnvDTE.dbgHitCountType.dbgHitCountTypeNone) As BreakpointsParameters
- Function
- String
Optional. A function breakpoint. The name of the function on which the breakpoint is set.
- File
- String
Optional. A file breakpoint. The name and optional path of the file in which the breakpoint is set.
- Line
- Int32
Optional. A file breakpoint. The source-code line number, measured from the start of the function, at which the breakpoint is set. If this value is 1, the breakpoint is set at the start of the function.
- Column
- Int32
Optional. A file breakpoint. The character at which the breakpoint is set. In most cases, you can leave this value set to 1, which sets the breakpoint at the start of the line.
- ConditionType
- dbgBreakpointConditionType
Optional. The condition type. A dbgBreakpointConditionType value. Use with Condition.
- Language
- String
Optional. The programming language in which the function is written.
- Data
- String
Optional. A data breakpoint. If the breakpoint is set on a variable, you can specify the name of the variable. You can use the context operator to specify a variable outside the current scope.
- DataCount
- Int32
Optional. A data breakpoint. If the breakpoint is set on a variable, and if the variable is an array or dereferenced pointer, this value specifies the number of elements to watch.
- Address
- String
Optional. An address breakpoint. The memory address where the breakpoint is set, in decimal or hexadecimal format.
- HitCount
- Int32
Optional. The Hit Count property for the breakpoint. If you specify no hit count, program execution breaks each time the breakpoint is hit. If you specify a hit count, program execution breaks only on the specified number of hits.
- HitCountType
- dbgHitCountType
Optional. The hit count type. A dbgHitCountType value.
Returns
A Breakpoints collection.
- Attributes
Examples
The following example demonstrates how to use the Add method.
public static void Add(DTE dte)
{
// Setup debug Output window.
Window w = (Window)dte.Windows.Item(EnvDTE.Constants.vsWindowKindOutput);
w.Visible = true;
OutputWindow ow = (OutputWindow)w.Object;
OutputWindowPane owp = ow.OutputWindowPanes.Add("Add Method Test: ");
owp.Activate();
EnvDTE.Debugger debugger = (EnvDTE.Debugger)dte.Debugger;
debugger.Breakpoints.Add("","Target001.cs", 13, 1, "",
EnvDTE.dbgBreakpointConditionType.dbgBreakpointConditionTypeWhenTrue,
"C#","", 0, "", 0, EnvDTE.dbgHitCountType.dbgHitCountTypeNone);
debugger.Breakpoints.Add("","Target001.cs", 15, 1, "",
EnvDTE.dbgBreakpointConditionType.dbgBreakpointConditionTypeWhenTrue,
"C#","", 0, "", 0, EnvDTE.dbgHitCountType.dbgHitCountTypeNone);
owp.OutputString("\nNumber of Breakpoints: " + debugger.Breakpoints.Count);
owp.OutputString("\nEdition of the environment: " +
debugger.Breakpoints.DTE.Edition);
owp.OutputString("\nParent's Current Mode: " +
debugger.Breakpoints.Parent.CurrentMode);
owp.OutputString("\nFirst breakpoint is on line " +
debugger.Breakpoints.Item(1).FileLine + ".");
owp.OutputString("\nSecond breakpoint is on line " +
debugger.Breakpoints.Item(2).FileLine + ".");
}
Shared Sub AddBreakpoint(ByRef dte As EnvDTE.DTE)
dte.Debugger.StepInto(True)
dte.Debugger.Breakpoints.Add("", "Target001.cs", 13, 1, "", _
EnvDTE.dbgBreakpointConditionType.dbgBreakpointConditionTypeWhenTrue, _
"C#", "", 0, "", 0, EnvDTE.dbgHitCountType.dbgHitCountTypeNone)
dte.Debugger.Breakpoints.Add("", "Target001.cs", 15, 1, "", _
EnvDTE.dbgBreakpointConditionType.dbgBreakpointConditionTypeWhenTrue, _
"C#", "", 0, "", 0, EnvDTE.dbgHitCountType.dbgHitCountTypeNone)
End Sub
Remarks
Creates and enables a new breakpoint and returns a Breakpoints collection.
All parameters for this method are optional; however you can specify only one of four location types, as described below.
| To set a breakpoint in this location type | Use parameter(s) |
|---|---|
| Within a function. | Function |
| Within a file. Can optionally specify the line and column location within the file. | File, Line, and Column |
| Within data. Can optionally be set for variables and the number of variables to watch. | Data and DataCount |
| At a specific address. | Address |
To any of these location types, you can optionally supply Condition and ConditionType to break only when a specified condition is true. You can optionally supply HitCount and HitCountType to break on the specified hit count.