IVsTextLines.GetLineDataEx Method

Article
09/25/2012

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 GetLineDataEx ( _
    dwFlags As UInteger, _
    iLine As Integer, _
    iStartIndex As Integer, _
    iEndIndex As Integer, _
    <OutAttribute> pLineData As LINEDATAEX(), _
    pMarkerData As MARKERDATA() _
) As Integer

'Usage
Dim instance As IVsTextLines 
Dim dwFlags As UInteger 
Dim iLine As Integer 
Dim iStartIndex As Integer 
Dim iEndIndex As Integer 
Dim pLineData As LINEDATAEX()
Dim pMarkerData As MARKERDATA()
Dim returnValue As Integer 

returnValue = instance.GetLineDataEx(dwFlags, _
    iLine, iStartIndex, iEndIndex, pLineData, _
    pMarkerData)

int GetLineDataEx(
    uint dwFlags,
    int iLine,
    int iStartIndex,
    int iEndIndex,
    LINEDATAEX[] pLineData,
    MARKERDATA[] pMarkerData
)

int GetLineDataEx(
    [InAttribute] unsigned int dwFlags, 
    [InAttribute] int iLine, 
    [InAttribute] int iStartIndex, 
    [InAttribute] int iEndIndex, 
    [OutAttribute] array<LINEDATAEX>^ pLineData, 
    [InAttribute] array<MARKERDATA>^ pMarkerData
)

function GetLineDataEx(
    dwFlags : uint, 
    iLine : int, 
    iStartIndex : int, 
    iEndIndex : int, 
    pLineData : LINEDATAEX[], 
    pMarkerData : MARKERDATA[]
) : int

Parameters

dwFlags
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] The line about which information is requested. 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. This value is ignored unless a value of gldeSubset is specified for dwFlags.

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[]

[in,out] Pointer to the filled-in LINEDATA structure. This is allocated by the caller and filled in by the GetLineDataEx method.

pMarkerData
Type: array<Microsoft.VisualStudio.TextManager.Interop.MARKERDATA[]

[in, optional] Pointer to a valid MARKERDATA structure. This is allocated by the caller and filled in by the GetLineDataEx method..

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::GetLineDataEx(
   [in] DWORD dwFlags,
   [in] long iLine,
   [in] long iStartIndex,
   [in] long iEndIndex,
   [out] LINEDATAEX *pLineData,
   [in] MARKERDATA *pMarkerData
);

This method is similar to GetLineData, but additionally fills in the MARKERDATA structure and allows you to specify additional information about the line or marker using the dwFlags parameter.

.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