Breakpoint.File Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the name of the file that contains the breakpoint or a declaration of the parent object.

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 representing a file name.

Attributes

DispIdAttribute

Examples

The following example demonstrates how to use the File property.

public static void File(DTE 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 Test: ");  
    owp.Activate();  

    EnvDTE.Debugger debugger = (EnvDTE.Debugger)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);  
}  

Shared Sub File(ByRef dte As EnvDTE.DTE)  
    Dim strFile As String  
    Dim strFileLine As String  
    Dim strFileColumn As String  
    Dim strEnabled As String  
    Dim boolEnabled As Boolean  

    dte.Debugger.StepInto(True)  
    dte.Debugger.Breakpoints.Add("", "Target001.cs", 15, 1, "", _  
                                 EnvDTE.dbgBreakpointConditionType.dbgBreakpointConditionTypeWhenTrue, _  
                                 "C#", "", 0, "", 0, EnvDTE.dbgHitCountType.dbgHitCountTypeNone)  
    strFile = dte.Debugger.Breakpoints.Item(1).File.ToString()  
    strFileLine = dte.Debugger.Breakpoints.Item(1).FileLine.ToString()  
    strFileColumn = dte.Debugger.Breakpoints.Item(1).FileColumn.ToString()  
    boolEnabled = dte.Debugger.Breakpoints.Item(1).Enabled  
    If boolEnabled = True Then  
        strEnabled = "enabled"  
    Else  
        strEnabled = "disabled"  
    End If  

    MessageBox.Show("Breakpoint in the file " + strFile + vbCrLf + _  
                    "on line " + strFileLine + " column " + strFileColumn + _  
                    " is " + strEnabled + ".")  
End Sub