Breakpoint.FileLine Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Indicates the line location within a file for a breakpoint.

public:
 property int FileLine { int get(); };

public:
 property int FileLine { int get(); };

[System.Runtime.InteropServices.DispId(106)]
public int FileLine { [System.Runtime.InteropServices.DispId(106)] get; }

[<System.Runtime.InteropServices.DispId(106)>]
[<get: System.Runtime.InteropServices.DispId(106)>]
member this.FileLine : int

Public ReadOnly Property FileLine As Integer

Property Value

Int32

An integer that represents the line number in the source code, measured from the start of the function, at which the breakpoint is set.

Attributes

DispIdAttribute

Examples

The following example demonstrates how to use the FileLine property.

public static void FileLine(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("FileLine 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 FileLine(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  

Remarks

If the return value is 1, the breakpoint is set at the start of the file. This is specified in the Line box of the File, New Breakpoint dialog box.