Debugger3 Interface

Reference

Definition

Namespace:: EnvDTE90

Assembly:: EnvDTE90.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Debugger3 is used to interrogate and manipulate the state of the debugger and the program being debugged. Debugger3 supersedes the Debugger2 and Debugger interfaces.

public interface class Debugger3 : EnvDTE80::Debugger2

public interface class Debugger3 : EnvDTE80::Debugger2

__interface Debugger3 : EnvDTE80::Debugger2

[System.Runtime.InteropServices.Guid("87DFC8DA-67B4-4954-BB89-6A277A50BAFC")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface Debugger3 : EnvDTE80.Debugger2

[System.Runtime.InteropServices.Guid("87DFC8DA-67B4-4954-BB89-6A277A50BAFC")]
public interface Debugger3 : EnvDTE80.Debugger2

[<System.Runtime.InteropServices.Guid("87DFC8DA-67B4-4954-BB89-6A277A50BAFC")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type Debugger3 = interface
    interface Debugger2

[<System.Runtime.InteropServices.Guid("87DFC8DA-67B4-4954-BB89-6A277A50BAFC")>]
type Debugger3 = interface
    interface Debugger2
    interface Debugger

Public Interface Debugger3
Implements Debugger2

Derived: EnvDTE100.Debugger5

EnvDTE90a.Debugger4

Attributes: GuidAttribute TypeLibTypeAttribute

Implements: Debugger Debugger2

Examples

Imports System  
Imports EnvDTE  
Imports EnvDTE90  
Imports EnvDTE90  
Imports System.Diagnostics  

Public Module Module1  
    'This function returns true if the debugger is actively debugging.  
    Function IsDebugging() As Boolean  
        Dim debugger As EnvDTE90.Debugger3 debugger = DTE.Debugger  
        If (debugger Is Nothing) Then  
            MsgBox("Debugger doesn't exist! Fatal error.")  
            IsDebugging = false  
        Else  
            IsDebugging = (debugger.CurrentMode <> _  
            dbgDebugMode.dbgDesignMode)  
        End If  
    End Function  
End Module

// The following C++ program can be run from the command line.  
// It detects whether an instance of Visual Studio is currently   
// running,and if so, prints a message stating whether its debugger  
// is actively debugging.  

#include <stdio.h>  
#import "dte90.olb" raw_interfaces_only named_guids  
using namespace EnvDTE90;  
int main(void)  
{  
    int nRet = 0;  
    CoInitialize(NULL);  
    IUnknownPtr pUnk;  
    GetActiveObject(CLSID_DTE, NULL, &pUnk);  
    if (pUnk == NULL) {  
        printf ("No instance of Visual Studio is running.\n");  
    }  
    else {  
        _DTEPtr pDTE = pUnk;  
        if (pDTE) {  
            DebuggerPtr pDebugger;  
            if (SUCCEEDED(pDTE->get_Debugger(&pDebugger3)) &&   
            pDebugger3  
            != NULL){  
                dbgDebugMode mode;  
                if (SUCCEEDED(pDebugger3->get_CurrentMode(&mode))) {  
                    if (mode != dbgDesignMode) {  
                        printf("Debugger is active.\n");  
                        nRet = 1;  
                    }  
                    else {  
                        printf("Debugger is not active.\n");  
                    }  
                }  
            }  
        }  
    }  
    CoUninitialize();  
    return nRet;  
}

Remarks

The debugger is available through the DTE2 object through its Debugger property, as shown in the following example. One debugger object is available for each instance of the interactive development environment (IDE).

Properties

AllBreakpointsLastHit	Gets a collection of bound breakpoints that were last simultaneously hit.
BreakpointLastHit	Gets the last breakpoint hit.
Breakpoints	Gets a collection of breakpoints.
CurrentMode	Gets the current mode of the debugger within the context of the IDE.
CurrentProcess	Gets or sets the active process.
CurrentProgram	Sets or returns the active program.
CurrentStackFrame	Gets or sets the current stack frame.
CurrentThread	Gets or sets the current thread being debugged.
DebuggedProcesses	Gets the list of processes that are being debugged.
DTE	Gets the top-level extensibility object.
ExceptionGroups	Gets the exception settings for the debugger. For each exception, these settings determine whether the debugger gives the code an opportunity to handle the exception before the debugger breaks execution.
ForceContinue	Gets or sets a value that determines whether the debugger breaks or continues when a tracepoint or breakpoint finishes executing a macro. The default behavior is set by the user in the dialog box when the tracepoint or breakpoint is created. This property can be used to change the default behavior.
HexDisplayMode	Gets or sets a value that indicates whether the expressions are output in hexadecimal or decimal format.
HexInputMode	Gets or sets a value that indicates whether the expressions are evaluated in hexadecimal or decimal format.
Languages	Gets a list of languages that the debugger supports.
LastBreakReason	Gets the last reason that a program was broken. If the program is running it returns `DBG_REASON_NONE`.
LocalProcesses	Gets the list of processes that currently running on this computer.
OnlyLoadSymbolsManually	Gets a value that determines whether symbols are loaded manually or automatically. The Visual Studio user can determine this setting in the Options dialog box. For more information about how to set this value within Visual Studio, see How to: Specify a Symbol Path.
Parent	Gets the immediate parent object of the Debugger3 object (DTE2).
SymbolCachePath	Gets a string that contains the path to the symbols cache used by Visual Studio when you download symbols from a symbols server. You can specify the symbols cache path in the Options dialog box. For more information, see How to: Use a Symbol.
SymbolPath	Gets a string that contains paths to .PDB symbol files that are used by Visual Studio for debugging. The Visual Studio user can specify symbols paths in the Options dialog box. For more information, see How to: Specify a Symbol Path.
SymbolPathState	Gets a string that represents the state of all symbol paths for the .PDB symbol files that are used by Visual Studio for debugging.
Transports	Gets a collection of supported debugging transports.

Methods

Break(Boolean)	Causes the given process to pause its execution so that its current state can be analyzed.
DetachAll()	Detaches from all attached programs.
ExecuteStatement(String, Int32, Boolean)	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.
GetExpression(String, Boolean, Int32)	Evaluates an expression based on the current stack frame. If the expression can be parsed but not evaluated, an object is returned but does not contain a valid value.
GetExpression2(String, Boolean, Boolean, Int32)	Evaluates an expression based on the current stack frame. If the expression can be parsed but not evaluated, an object is returned but does not contain a valid value. This member function is similar to GetExpression(String, Boolean, Int32) but with an additional Boolean parameter, which can be set to true to indicate that the expression is to be evaluated as a statement.
GetProcesses(Transport, String)
Go(Boolean)	Starts executing the program from the current statement.
RunToCursor(Boolean)	Executes the program to the current position of the source file cursor.
SetNextStatement()	Sets the next instruction to be executed, according to the cursor position in the current source file.
SetSymbolSettings(String, String, String, Boolean, Boolean)	Sets various settings for the .PDB symbols used by Visual Studio for debugging and forces reloading of all symbols.
StepInto(Boolean)	Steps into the next function call, if possible.
StepOut(Boolean)	Steps out of the current function.
StepOver(Boolean)	Steps over the next function call.
Stop(Boolean)	Stops debugging and terminates or detaches from all attached processes.
TerminateAll()	Terminates all currently running debugging processes.
WriteMinidump(String, dbgMinidumpOption)

Applies to

Share via