Breakpoint2.File Property

Gets the name of the file in which the breakpoint is contained.

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

Syntax

'Declaration
ReadOnly Property File As String

string File { get; }

property String^ File {
    String^ get ();
}

abstract File : string with get

function get File () : String

Property Value

Type: String
A string containing the name of the file in which the breakpoint is contained.

Examples

The following example demonstrates how to use the File property.

To test this property:

1. Set a breakpoint in the target application.

2. Run the add-in.

public static void File(EnvDTE80.DTE2 dte)
{
    // Setup 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("File property: ");
    owp.Activate();

    // dte is a reference to the DTE2 object passed to you by the
    // OnConnection method that you implement when you create an Add-in.
    EnvDTE80.Debugger2 debugger = (EnvDTE80.Debugger2)dte.Debugger;
    owp.OutputString("Breakpoint in the file " + debugger.Breakpoints.Item(1).File);
    owp.OutputString(" on line " +
                     debugger.Breakpoints.Item(1).FileLine.ToString() + " column ");
    owp.OutputString(debugger.Breakpoints.Item(1).FileColumn.ToString() + " is ");
    owp.OutputString(debugger.Breakpoints.Item(1).Enabled ? "enabled." : "disabled.");
    owp.OutputString("\nThis breakpoint is in the function: " +
                     debugger.Breakpoints.Item(1).FunctionName);
}

Sub FileExample(ByVal dte As DTE2)

    ' NOTE: This example requires a reference to the 
    '       System.Collections namespace.

    ' Before running this example, open a project.
    Dim list As New SortedList()
    Dim brk As Breakpoint
    For Each brk In dte.Debugger.Breakpoints
        If brk.Enabled Then
            list(brk.File) = brk.File
        End If
    Next

    Dim file As DictionaryEntry
    Dim files As String
    For Each file In list
        files &= file.Value.ToString() & vbCrLf
    Next

    MsgBox("The following files have active breakpoints:" & _
        vbCrLf & vbCrLf & files)

End Sub

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

Breakpoint2 Interface

EnvDTE80 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples