Debugger3 Interface

  • Article

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

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

Syntax

'Declaration
<GuidAttribute("87DFC8DA-67B4-4954-BB89-6A277A50BAFC")> _
Public Interface Debugger3 _
    Inherits Debugger2

[GuidAttribute("87DFC8DA-67B4-4954-BB89-6A277A50BAFC")]
public interface Debugger3 : Debugger2

[GuidAttribute(L"87DFC8DA-67B4-4954-BB89-6A277A50BAFC")]
public interface class Debugger3 : Debugger2

[<GuidAttribute("87DFC8DA-67B4-4954-BB89-6A277A50BAFC")>]
type Debugger3 =  
    interface 
        interface Debugger2 
    end

public interface Debugger3 extends Debugger2

The Debugger3 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 that are being debugged.
Public property DTE Gets the top-level extensibility object.
Public property 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.
Public property 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.
Public property HexDisplayMode Gets or sets a value that indicates whether the expressions are output in hexadecimal or decimal format.
Public property HexInputMode Gets or sets a value that indicates 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 that currently running on this computer.
Public property 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 [OBSOLETE] How to: Specify Symbol Locations and Loading Behavior.
Public property Parent Gets the immediate parent object of the Debugger3 object (DTE2).
Public property 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 [OBSOLETE] How to: Use a Symbol Server.
Public property 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 [OBSOLETE] How to: Specify Symbol Locations and Loading Behavior.
Public property 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.
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. This member function is similar to GetExpression but with an additional Boolean parameter, which can be set to true to indicate that the expression is to be evaluated as a statement.
Public method GetProcesses
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 SetSymbolSettings Sets various settings for the .PDB symbols used by Visual Studio for debugging and forces reloading of all symbols.
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

Top

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).

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

See Also

Reference

EnvDTE90 Namespace