IVsTextLines::GetLineIndexOfPosition Method (Int32, Int32, Int32)

Visual Studio 2015

Returns the line and column numbers in the text buffer, given a position number.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

C++

int GetLineIndexOfPosition(
	int iPosition,
	[OutAttribute] int% piLine,
	[OutAttribute] int% piColumn
)

Parameters

iPosition: Type: System::Int32
[in] Position number of the desired line.

piLine: Type: System::Int32
[out] Pointer to the line number.

piColumn: Type: System::Int32
[out] Pointer to the column position on the line.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

IVsTextBuffer::GetLineIndexOfPosition(Int32, Int32, Int32)

Remarks

COM Signature

From textmgr.idl:

C++

HRESULT IVsTextLines::GetLineIndexOfPosition(
   [in] long iPosition,
   [out] long *piLine,
   [out] CharIndex *piColumn
);

This method could require considerable resources, depending upon the underlying implementation of the buffer. That is, it could be very difficult to calculate the size of the buffer if it is a virtual-line-oriented implementation as in Visual Basic.