Debugger2 Interface

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public interface class Debugger2 : EnvDTE::Debugger

public interface class Debugger2 : EnvDTE::Debugger

__interface Debugger2 : EnvDTE::Debugger

[System.Runtime.InteropServices.Guid("8B5E2BFD-4642-4EFE-8AF4-0B2DA9AAA23C")]
public interface Debugger2 : EnvDTE.Debugger

[<System.Runtime.InteropServices.Guid("8B5E2BFD-4642-4EFE-8AF4-0B2DA9AAA23C")>]
type Debugger2 = interface
    interface Debugger

Public Interface Debugger2
Implements Debugger

Derived

EnvDTE100.Debugger5

EnvDTE90.Debugger3

EnvDTE90a.Debugger4

Attributes

GuidAttribute

Implements

Debugger

Examples

Imports EnvDTE  
Imports System.Diagnostics  

Public Module Module1  
    'This function returns true if the debugger is actively debugging.  

    Function IsDebugging() As Boolean  
        Dim debugger As EnvDTE80.Debugger2 debugger = DTE2.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 "dte.olb" raw_interfaces_only named_guids  
using namespace EnvDTE80;  
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(&pDebugger2)) &&   
            pDebugger2  
            != NULL){  
                dbgDebugMode mode;  
                if (SUCCEEDED(pDebugger2->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 via its Debugger property, as shown in the example below. One debugger object is available for each instance of the development environment.

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 currently being debugged.
DTE	Gets the top-level extensibility object.
HexDisplayMode	Gets or sets a value indicating whether the expressions are output in hexadecimal or decimal format.
HexInputMode	Gets or sets a value indicating 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 currently running on this machine.
Parent	Gets the immediate parent object of the Debugger2 object (DTE2).
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.
GetProcesses(Transport, String)	Allows the caller to get a collection of processes from a remote machine.
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.
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)	If debugging a program and in Break mode, this function creates a minidump of the current debugging session.