IPersistentSpan.TryGetEndLineIndex(Int32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text

Assembly:: Microsoft.VisualStudio.Text.Data.dll

Package:: Microsoft.VisualStudio.Text.Data v17.11.260

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get the ending point of the span as a line number and offset from the start of the line.

public:
 bool TryGetEndLineIndex([Runtime::InteropServices::Out] int % endLine, [Runtime::InteropServices::Out] int % endIndex);

bool TryGetEndLineIndex([Runtime::InteropServices::Out] int & endLine, [Runtime::InteropServices::Out] int & endIndex);

public bool TryGetEndLineIndex (out int endLine, out int endIndex);

abstract member TryGetEndLineIndex : int * int -> bool

Public Function TryGetEndLineIndex (ByRef endLine As Integer, ByRef endIndex As Integer) As Boolean

Parameters

endLine: Int32

Line number of the end point.

endIndex: Int32

Character offset from the start of the line containing the end point.

Returns

Boolean

true if the the out parameters are valid; false otherwise (in which case TryGetSpan will work).

Remarks

This method can be used on any span if the underlying document is open.

If the underlying document is closed, then this method can be used if either the document was created on the closed document using the line/index method of the factory or the document had ever been opened after the span was created.

In general, you should try this method (and TryGetStartLineIndex(Int32, Int32)) before using TryGetSpan(Span).

Applies to

Share via