IVsTextLines.GetLineIndexOfPosition(Int32, Int32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

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

public:
 int GetLineIndexOfPosition(int iPosition, [Runtime::InteropServices::Out] int % piLine, [Runtime::InteropServices::Out] int % piColumn);

int GetLineIndexOfPosition(int iPosition, [Runtime::InteropServices::Out] int & piLine, [Runtime::InteropServices::Out] int & piColumn);

public int GetLineIndexOfPosition (int iPosition, out int piLine, out int piColumn);

abstract member GetLineIndexOfPosition : int * int * int -> int

Public Function GetLineIndexOfPosition (iPosition As Integer, ByRef piLine As Integer, ByRef piColumn As Integer) As Integer

Parameters

iPosition: Int32

[in] Position number of the desired line.

piLine: Int32

[out] Pointer to the line number.

piColumn: Int32

[out] Pointer to the column position on the line.

Returns

Int32

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

Implements

GetLineIndexOfPosition(Int32, Int32, Int32)

Remarks

COM Signature

From textmgr.idl:

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.

Applies to