Debugger3.RunToCursor(Boolean) Method

Definition

Namespace:

EnvDTE90

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Executes the program to the current position of the source file cursor.

void RunToCursor(bool WaitForBreakOrEnd = true);

[System.Runtime.InteropServices.DispId(10)]
public void RunToCursor (bool WaitForBreakOrEnd = true);

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

Public Sub RunToCursor (Optional WaitForBreakOrEnd As Boolean = true)

Parameters

WaitForBreakOrEnd

Boolean

Set to true if this function call should wait until either Break mode or Design mode is entered before returning. Set to false if you want this call to return immediately after causing the debugger to begin execution. Upon return the debugger could be in Design, Break, or Run modes.

For more information, see Code Stepping Overview.

Implements

RunToCursor(Boolean)

Attributes

DispIdAttribute

Examples

The following example shows how to use the RunToCursor method.

public static void RunToCursor(EnvDTE80.DTE2 dte)  
{  
    EnvDTE.TextSelection ts =   
    (EnvDTE.TextSelection)dte.ActiveDocument.Selection;  
    ts.GotoLine(15, false);  
    EnvDTE90.Debugger3 debugger = (EnvDTE90.Debugger3)dte.Debugger;  

    debugger.RunToCursor(true);  

    // 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("RunToCursor Method   
    Test");  
    owp.Activate();  
    if (debugger.CurrentProgram.IsBeingDebugged)  
        owp.OutputString("This program is being debugged and " +  
                         "the cursor is on line: " + ts.CurrentLine);  
    else  
        owp.OutputString("This program is not being debugged.");  
}  

Sub RunToLine(Optional ByVal line As Integer = -1)  
    If line <> -1 Then  
        Dim ts As TextSelection  
        ts = DTE2.ActiveDocument.Selection  
        ts.GotoLine(line)  
        DTE2.Debugger.RunToCursor()  
    End If  
End Sub  

Remarks

RunToCursor executes the program to the current position of the source file cursor. For more information, see How to: Run to a Specified Location.