Breakpoint2.File Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public:
 property System::String ^ File { System::String ^ get(); };

public:
 property Platform::String ^ File { Platform::String ^ get(); };

[System.Runtime.InteropServices.DispId(105)]
public string File { [System.Runtime.InteropServices.DispId(105)] get; }

[<System.Runtime.InteropServices.DispId(105)>]
[<get: System.Runtime.InteropServices.DispId(105)>]
member this.File : string

Public ReadOnly Property File As String

Property Value

String

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

Implements

File

Attributes

DispIdAttribute

Examples

The following example demonstrates how to use the File property.

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();  

    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