Breakpoint.Condition Property

Specifies the condition for the breakpoint.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
ReadOnly Property Condition As String
string Condition { get; }
property String^ Condition {
    String^ get ();
}
abstract Condition : string with get
function get Condition () : String

Property Value

Type: System.String
A string representing the breakpoint condition for the property.

Remarks

A condition is an optional property that determines whether your program breaks when the breakpoint is reached. This condition is specified in the Breakpoint Condition dialog box.

The returned string is usually an expression used to determine when a breakpoint is hit.

Examples

The following example demonstrates how to use the Condition property.

To test this property:

  1. Run the add-in.

  2. Run the target application.

public static void Condition(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("Breakpoint Condition Test: ");
    owp.Activate();
    
    //dte is a reference to the DTE object passed to you by the
    //OnConnection method that you implement when you create an add-in.
    EnvDTE.Debugger debugger = (EnvDTE.Debugger)dte.Debugger;
    //Stop at the breakpoint if TempC < TempF is true
    debugger.Breakpoints.Add("","Target001.cs", 15, 1, "tempC < tempF", 
    EnvDTE.dbgBreakpointConditionType.dbgBreakpointConditionTypeWhenTrue, 
    "C#","", 0, "", 0, EnvDTE.dbgHitCountType.dbgHitCountTypeNone);
    string strCondition = debugger.Breakpoints.Item(1).Condition;
    string strConditionType = debugger.Breakpoints.Item(1).ConditionType.ToString();
    owp.OutputString(strCondition + "\n" + strConditionType);
}
Shared Sub Condition(ByRef dte As EnvDTE.DTE)
    Dim strCondition As String
    Dim strType As String

    dte.Debugger.StepInto(True)
    dte.Debugger.Breakpoints.Add("", "Target001.cs", 15, 1, "tempC < tempF", _
                                 EnvDTE.dbgBreakpointConditionType.dbgBreakpointConditionTypeWhenTrue, _
                                 "C#", "", 0, "", 0, EnvDTE.dbgHitCountType.dbgHitCountTypeNone)
    strCondition = dte.Debugger.Breakpoints.Item(1).Condition.ToString()
    strType = dte.Debugger.Breakpoints.Item(1).ConditionType.ToString()
    MessageBox.Show("Condition Property Test: " + vbCrLf + _
                    strCondition + vbCrLf + strType)
End Sub

.NET Framework Security

See Also

Reference

Breakpoint Interface

EnvDTE Namespace

Other Resources

<PAVE OVER> How to: Specify a Breakpoint Condition

<PAVE OVER> How to: Specify a Hit Count