Debugger2 Interface

  • Article

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.

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

Syntax

'Declaration
<GuidAttribute("8B5E2BFD-4642-4EFE-8AF4-0B2DA9AAA23C")> _
Public Interface Debugger2 _
    Inherits Debugger

[GuidAttribute("8B5E2BFD-4642-4EFE-8AF4-0B2DA9AAA23C")]
public interface Debugger2 : Debugger

[GuidAttribute(L"8B5E2BFD-4642-4EFE-8AF4-0B2DA9AAA23C")]
public interface class Debugger2 : Debugger

[<GuidAttribute("8B5E2BFD-4642-4EFE-8AF4-0B2DA9AAA23C")>]
type Debugger2 =  
    interface 
        interface Debugger 
    end

public interface Debugger2 extends Debugger

The Debugger2 type exposes the following members.

Properties

  Name Description
Public property AllBreakpointsLastHit Gets a collection of bound breakpoints that were last simultaneously hit.
Public property BreakpointLastHit Gets the last breakpoint hit.
Public property Breakpoints Gets a collection of breakpoints.
Public property CurrentMode Gets the current mode of the debugger within the context of the IDE.
Public property CurrentProcess Gets or sets the active process.
Public property CurrentProgram Sets or returns the active program.
Public property CurrentStackFrame Gets or sets the current stack frame.
Public property CurrentThread Gets or sets the current thread being debugged.
Public property DebuggedProcesses Gets the list of processes currently being debugged.
Public property DTE Gets the top-level extensibility object.
Public property HexDisplayMode Gets or sets a value indicating whether the expressions are output in hexadecimal or decimal format.
Public property HexInputMode Gets or sets a value indicating whether the expressions are evaluated in hexadecimal or decimal format.
Public property Languages Gets a list of languages that the debugger supports.
Public property LastBreakReason Gets the last reason that a program was broken. If the program is running it returns DBG_REASON_NONE.
Public property LocalProcesses Gets the list of processes currently running on this machine.
Public property Parent Gets the immediate parent object of the Debugger2 object (DTE2).
Public property Transports Gets a collection of supported debugging transports.

Top

Methods

  Name Description
Public method Break Causes the given process to pause its execution so that its current state can be analyzed.
Public method DetachAll Detaches from all attached programs.
Public method ExecuteStatement 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.
Public method GetExpression 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.
Public method GetExpression2 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.
Public method GetProcesses Allows the caller to get a collection of processes from a remote machine.
Public method Go Starts executing the program from the current statement.
Public method RunToCursor Executes the program to the current position of the source file cursor.
Public method SetNextStatement Sets the next instruction to be executed, according to the cursor position in the current source file.
Public method StepInto Steps into the next function call, if possible.
Public method StepOut Steps out of the current function.
Public method StepOver Steps over the next function call.
Public method Stop Stops debugging and terminates or detaches from all attached processes.
Public method TerminateAll Terminates all currently running debugging processes.
Public method WriteMinidump If debugging a program and in Break mode, this function creates a minidump of the current debugging session.

Top

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.

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;
}

See Also

Reference

EnvDTE80 Namespace