Debugger.RunToCursor Method

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

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

Syntax

'Declaration
Sub RunToCursor ( _
    WaitForBreakOrEnd As Boolean _
)

void RunToCursor(
    bool WaitForBreakOrEnd
)

void RunToCursor(
    [InAttribute] bool WaitForBreakOrEnd
)

abstract RunToCursor : 
        WaitForBreakOrEnd:bool -> unit 

function RunToCursor(
    WaitForBreakOrEnd : boolean
)

Parameters

• WaitForBreakOrEnd
  Type: System.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.
  See Stepping for more information.

Remarks

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

Examples

The following example demonstrates how to use the RunToCursor method.

To test this method:

1. Open the target project and run the add-in.

public static void RunToCursor(DTE dte)
{
    EnvDTE.TextSelection ts = (EnvDTE.TextSelection)dte.ActiveDocument.Selection;
    ts.GotoLine(15, false);
    dte.Debugger.RunToCursor(true);

    // Setup the 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(dte.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.");
}

Shared Sub RunToCursor(ByRef dte As EnvDTE.DTE)
    Dim ts As EnvDTE.TextSelection = dte.ActiveDocument.Selection
    ts.GotoLine(15, False)
    dte.Debugger.RunToCursor(True)
    If dte.Debugger.CurrentProgram.IsBeingDebugged Then
        MessageBox.Show("This program is being debugged and the cursor is on line: " + ts.CurrentLine.ToString(), _
                        "Debugger Test - RunToCursor Test")
    Else
        MessageBox.Show("This program is not being debugged.", _
                        "Debugger Test - RunToCursor Test")
    End If
End Sub

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

Debugger Interface

EnvDTE Namespace