Breakpoint2 Interface
Contains the properties and methods used to programmatically manipulate a breakpoint.
Namespace: EnvDTE80
Assembly: EnvDTE80 (in EnvDTE80.dll)
Syntax
'Declaration
<GuidAttribute("FBC8D85A-E449-4CB3-B026-F7808DEB7792")> _
Public Interface Breakpoint2 _
Inherits Breakpoint
[GuidAttribute("FBC8D85A-E449-4CB3-B026-F7808DEB7792")]
public interface Breakpoint2 : Breakpoint
[GuidAttribute(L"FBC8D85A-E449-4CB3-B026-F7808DEB7792")]
public interface class Breakpoint2 : Breakpoint
[<GuidAttribute("FBC8D85A-E449-4CB3-B026-F7808DEB7792")>]
type Breakpoint2 =
interface
interface Breakpoint
end
public interface Breakpoint2 extends Breakpoint
The Breakpoint2 type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
BreakWhenHit | Gets or sets a value indicating whether the program breaks when a breakpoint is encountered. |
|
Children | Gets a collection of all Breakpoint2 child objects. |
|
Collection | Gets the collection containing all of the Breakpoint2 objects. |
|
Condition | Gets the condition that triggers a breakpoint. |
|
ConditionType | Gets the condition type of the breakpoint, which can be either break when true, or break when changed. |
|
CurrentHits | Gets the number of times this breakpoint has been hit during this debugging session. |
|
DTE | Gets the top-level extensibility object. |
|
Enabled | Sets or returns the enabled state of the breakpoint. |
|
File | Gets the name of the file in which the breakpoint is contained. |
|
FileColumn | Gets the character location within a line in a file where the breakpoint is set. |
|
FileLine | Gets the line within a file where the breakpoint is set. |
|
FilterBy | Gets or sets a condition at which a breakpoint is set. |
|
FunctionColumnOffset | Gets the column offset from the name of a function breakpoint. |
|
FunctionLineOffset | Gets the line offset from the name of a function breakpoint. |
|
FunctionName | Gets the name of the function containing the breakpoint. |
|
HitCountTarget | Gets the hit count target for any type of breakpoint. It is interpreted based on the hit count type. |
|
HitCountType | Gets the hit count type, which describes how to interpret a hit count. |
|
Language | Gets the name of the programming language containing the breakpoint. |
|
LocationType | Gets the location type the breakpoint represents. |
|
Macro | Gets or sets a breakpoint macro. |
|
Message | Gets or sets a breakpoint message. |
|
Name | Sets or returns the name of the breakpoint. |
|
Parent | Gets the immediate parent object of the breakpoint. |
|
Process | Gets the Process2 associated with the current breakpoint. |
|
Program | Gets the executable being managed by this process. |
|
Tag | Sets or gets a user-defined string identifying this breakpoint. |
|
Type | Gets a constant specifying the type of breakpoint. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Delete | Deletes the breakpoint. |
|
ResetHitCount | Resets the breakpoint hit count. |
Top
Examples
The following example demonstrates how to use the Children property on the Breakpoint2 object.
To test this property:
Set a breakpoint in the target application.
Run the add-in.
The number of breakpoint children is zero.
Run the target application in the debug mode.
When the program stops on the breakpoint, run the add-in.
The number of children is one.
public static void Children(EnvDTE80.DTE2 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("Children Property
Test");
owp.Activate();
//dte is a reference to the DTE2 object passed to you by the
//OnConnection method that you implement when you create an Add-in.
EnvDTE80.Debugger2 debugger = (EnvDTE80.Debugger2)dte.Debugger;
owp.OutputString("Number of children: " +
debugger.Breakpoints.Item(1).Children.Count.ToString());
}