Debugger2.Break(Boolean) Method

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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.

Causes the given process to pause its execution so that its current state can be analyzed.

void Break(bool WaitForBreakMode = true);

[System.Runtime.InteropServices.DispId(7)]
public void Break (bool WaitForBreakMode = true);

[<System.Runtime.InteropServices.DispId(7)>]
abstract member Break : bool -> unit

Public Sub Break (Optional WaitForBreakMode As Boolean = true)

Parameters

WaitForBreakMode: Boolean

Set to true to return only when the debugger has entered break mode. Set to false to break and return immediately. See How to: Break Execution for more information.

Implements

Break(Boolean)

Attributes: DispIdAttribute

Examples

The following example demonstrates how to use the Break method.

public static void Break(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("Break Method   
    Test");  
    owp.Activate();  

    EnvDTE80.Debugger2 debugger = (EnvDTE80.Debugger2)dte.Debugger;  
    debugger.Break(false);  
    owp.OutputString("The process is paused. Examine the values of   
    variables.");  
}

Remarks