IVsTextLines.GetLineDataEx Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int GetLineDataEx(System::UInt32 dwFlags, int iLine, int iStartIndex, int iEndIndex, cli::array <Microsoft::VisualStudio::TextManager::Interop::LINEDATAEX> ^ pLineData, cli::array <Microsoft::VisualStudio::TextManager::Interop::MARKERDATA> ^ pMarkerData);

int GetLineDataEx(unsigned int dwFlags, int iLine, int iStartIndex, int iEndIndex, std::Array <Microsoft::VisualStudio::TextManager::Interop::LINEDATAEX> const & pLineData, std::Array <Microsoft::VisualStudio::TextManager::Interop::MARKERDATA> const & pMarkerData);

public int GetLineDataEx (uint dwFlags, int iLine, int iStartIndex, int iEndIndex, Microsoft.VisualStudio.TextManager.Interop.LINEDATAEX[] pLineData, Microsoft.VisualStudio.TextManager.Interop.MARKERDATA[] pMarkerData);

abstract member GetLineDataEx : uint32 * int * int * int * Microsoft.VisualStudio.TextManager.Interop.LINEDATAEX[] * Microsoft.VisualStudio.TextManager.Interop.MARKERDATA[] -> int

Public Function GetLineDataEx (dwFlags As UInteger, iLine As Integer, iStartIndex As Integer, iEndIndex As Integer, pLineData As LINEDATAEX(), pMarkerData As MARKERDATA()) As Integer

Parameters

dwFlags: UInt32

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

iLine: Int32

[in] The line about which information is requested. This is a zero-based value.

iStartIndex: 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: Int32

[in] Ending character index within the line. Must be less than or equal to the length of the line.

pLineData: LINEDATAEX[]

[in,out] Pointer to the filled-in LINEDATA structure. This is allocated by the caller and filled in by the GetLineDataEx(UInt32, Int32, Int32, Int32, LINEDATAEX[], MARKERDATA[]) method.

pMarkerData: MARKERDATA[]

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

Returns

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.

Applies to

Share via