IVsTextLines.GetLineText Method

Article
05/06/2010

Returns the specified span of text in a BSTR.

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

Syntax

'Déclaration
Function GetLineText ( _
    iStartLine As Integer, _
    iStartIndex As Integer, _
    iEndLine As Integer, _
    iEndIndex As Integer, _
    <OutAttribute> ByRef pbstrBuf As String _
) As Integer
'Utilisation
Dim instance As IVsTextLines
Dim iStartLine As Integer
Dim iStartIndex As Integer
Dim iEndLine As Integer
Dim iEndIndex As Integer
Dim pbstrBuf As String
Dim returnValue As Integer

returnValue = instance.GetLineText(iStartLine, _
    iStartIndex, iEndLine, iEndIndex, _
    pbstrBuf)

int GetLineText(
    int iStartLine,
    int iStartIndex,
    int iEndLine,
    int iEndIndex,
    out string pbstrBuf
)

int GetLineText(
    [InAttribute] int iStartLine, 
    [InAttribute] int iStartIndex, 
    [InAttribute] int iEndLine, 
    [InAttribute] int iEndIndex, 
    [OutAttribute] String^% pbstrBuf
)

abstract GetLineText : 
        iStartLine:int * 
        iStartIndex:int * 
        iEndLine:int * 
        iEndIndex:int * 
        pbstrBuf:string byref -> int

function GetLineText(
    iStartLine : int, 
    iStartIndex : int, 
    iEndLine : int, 
    iEndIndex : int, 
    pbstrBuf : String
) : int

Parameters

iStartLine
Type: System.Int32
[in] Starting line.

iStartIndex
Type: System.Int32
[in] Starting character index within the line. This value must be less than or equal to the length of the line.

iEndLine
Type: System.Int32
[in] Ending line.

iEndIndex
Type: System.Int32
[in] Ending character index within the line. This value must be less than or equal to the length of the line.

pbstrBuf
Type: System.String%
[out] Text to insert, if any.

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 IVsTextLines::GetLineText(
   [in] long iStartLine,
   [in] CharIndex iStartIndex,
   [in] long iEndLine,
   [in] CharIndex iEndIndex,
   [out] BSTR * pbstrBuf
);

It is the caller's responsibility to free the BSTR.

.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.