IVsTextStream.GetPositionOfLineIndex Method (Int32, Int32, Int32%)

Article
05/06/2010

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

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

Syntax

'Déclaration
Function GetPositionOfLineIndex ( _
    iLine As Integer, _
    iIndex As Integer, _
    <OutAttribute> ByRef piPosition As Integer _
) As Integer
'Utilisation
Dim instance As IVsTextStream
Dim iLine As Integer
Dim iIndex As Integer
Dim piPosition As Integer
Dim returnValue As Integer

returnValue = instance.GetPositionOfLineIndex(iLine, _
    iIndex, piPosition)

int GetPositionOfLineIndex(
    int iLine,
    int iIndex,
    out int piPosition
)

int GetPositionOfLineIndex(
    [InAttribute] int iLine, 
    [InAttribute] int iIndex, 
    [OutAttribute] int% piPosition
)

abstract GetPositionOfLineIndex : 
        iLine:int * 
        iIndex:int * 
        piPosition:int byref -> int

function GetPositionOfLineIndex(
    iLine : int, 
    iIndex : int, 
    piPosition : int
) : int

Parameters

iLine
Type: System.Int32
[in] Number of the line whose position is requested.

iIndex
Type: System.Int32
[in] Location of the character on iLine.

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.

Implements

IVsTextBuffer.GetPositionOfLineIndex(Int32, Int32, Int32%)

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTextStream::GetPositionOfLineIndex(
   [in] long iLine,
   [in] CharIndex iIndex,
   [out] long *piPosition
);

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 of the buffer, as in Visual Basic.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via