Share via


IVsTextBuffer.GetPositionOfLine Method

Returns the position number of a line.

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

Syntax

'Declaration
Function GetPositionOfLine ( _
    iLine As Integer, _
    <OutAttribute> ByRef piPosition As Integer _
) As Integer
int GetPositionOfLine(
    int iLine,
    out int piPosition
)
int GetPositionOfLine(
    [InAttribute] int iLine, 
    [OutAttribute] int% piPosition
)
abstract GetPositionOfLine : 
        iLine:int * 
        piPosition:int byref -> int 
function GetPositionOfLine(
    iLine : int, 
    piPosition : int
) : int

Parameters

  • iLine
    Type: System.Int32
    [in] Number of the line whose position is requested.
  • piPosition
    Type: System.Int32%
    [out] Pointer to the equivalent position number.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTextBuffer::GetPositionOfLine(
   [in] long iLine,
   [out] long *piPosition
);

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

.NET Framework Security

See Also

Reference

IVsTextBuffer Interface

Microsoft.VisualStudio.TextManager.Interop Namespace