IVsTextImage.GetLine Method

Article
03/11/2013

Provides direct, line-oriented access to the text buffer.

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

Syntax

'Declaration
Function GetLine ( _
    grfGet As UInteger, _
    iLine As Integer, _
    iStartIndex As Integer, _
    iEndIndex As Integer, _
    <OutAttribute> pLineData As LINEDATAEX() _
) As Integer

int GetLine(
    uint grfGet,
    int iLine,
    int iStartIndex,
    int iEndIndex,
    LINEDATAEX[] pLineData
)

int GetLine(
    [InAttribute] unsigned int grfGet, 
    [InAttribute] int iLine, 
    [InAttribute] int iStartIndex, 
    [InAttribute] int iEndIndex, 
    [OutAttribute] array<LINEDATAEX>^ pLineData
)

abstract GetLine : 
        grfGet:uint32 * 
        iLine:int * 
        iStartIndex:int * 
        iEndIndex:int * 
        pLineData:LINEDATAEX[] byref -> int

function GetLine(
    grfGet : uint, 
    iLine : int, 
    iStartIndex : int, 
    iEndIndex : int, 
    pLineData : LINEDATAEX[]
) : int

Parameters

grfGet
Type: System.UInt32
[in] Flags providing additional information about the line. For a list of dwFlags values, see GLDE_FLAGS.

iLine
Type: System.Int32
[in] Integer containing the line number. This is a zero-based value.

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

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

pLineData
Type: array<Microsoft.VisualStudio.TextManager.Interop.LINEDATAEX[]
[out] Pointer to the filled-in LINEDATA structure. This is allocated by the environment and filled in by the GetLine method.

Return Value

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

Remarks

Use the elements of grfGet to specify the level of locking you want to institute. The environment will call ReleaseLine when the line is no longer needed.

COM Signature

From textmgr.idl:

HRESULT IVsTextImage::GetLine(
   [in] DWORD grfGet,
   [in] LONG iLine,
   [in] LONG iStartIndex,
   [in] LONG iEndIndex,
   [out, retval] LINEDATAEX * pLineData
);

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

Share via