Debugger.ExecuteStatement(String, Int32, Boolean) Method

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Executes the specified statement. If the TreatAsExpression flag is true, then the string is interpreted as an expression, and output is sent to the Command Window.

void ExecuteStatement(std::wstring const & Statement, int Timeout = -1, bool TreatAsExpression = false);

[System.Runtime.InteropServices.DispId(11)]
public void ExecuteStatement (string Statement, int Timeout = -1, bool TreatAsExpression = false);

[<System.Runtime.InteropServices.DispId(11)>]
abstract member ExecuteStatement : string * int * bool -> unit

Public Sub ExecuteStatement (Statement As String, Optional Timeout As Integer = -1, Optional TreatAsExpression As Boolean = false)

Parameters

Statement

String

The statement to execute.

Timeout

Int32

The timeout period, in milliseconds.

TreatAsExpression

Boolean

The treat as expression. True if the string is to be interpreted as an expression; otherwise False.

Attributes

DispIdAttribute

Examples

The following example demonstrates how to use the ExecuteStatement method.

public static void ExecuteStatement(DTE dte)  
{  
    // 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("ExecuteStatement Method Test");  
    owp.Activate();  

    dte.Debugger.ExecuteStatement("tempC = 100.0", 100, false);  
}  

Shared Sub ExecuteStatementTest(ByRef dte As EnvDTE.DTE)  
    dte.Debugger.ExecuteStatement("tempC = 100.0", 100, False)  
End Sub  

Remarks

ExecuteStatement executes the specified statement. A statement differs from an expression in that a statement can consist of one or more expressions. Therefore, typically no value can be associated or returned by statement execution.

Some languages, such as Visual Basic, support a language syntax in which the context in which a statement appears indicates how the statement should be evaluated. For example, if your Visual Basic code has statement, a = 1, it is interpreted as an expression if the code appears inside an If...Then statement. For more information, see If...Then...Else Statement. In that case, it is interpreted as a statement if it appears alone on a line. The expression tests a against the value of 1; the statement sets a equal to 2. See the Example below.

Output from this method is sent to the Command window.