Breakpoint.Condition Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Specifies the condition for the breakpoint.

public:
 property System::String ^ Condition { System::String ^ get(); };

public:
 property Platform::String ^ Condition { Platform::String ^ get(); };

[System.Runtime.InteropServices.DispId(109)]
public string Condition { [System.Runtime.InteropServices.DispId(109)] get; }

[<System.Runtime.InteropServices.DispId(109)>]
[<get: System.Runtime.InteropServices.DispId(109)>]
member this.Condition : string

Public ReadOnly Property Condition As String

Property Value

String

A string representing the breakpoint condition for the property.

Attributes

DispIdAttribute

Examples

The following example demonstrates how to use the Condition property.

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();  

    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  

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.