IVsTextLines.FindMarkerByLineIndex Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Locates a marker of a given type based on a line index.

public:
 int FindMarkerByLineIndex(int iMarkerType, int iStartingLine, int iStartingIndex, System::UInt32 dwFlags, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsTextLineMarker ^ % ppMarker);

public:
 int FindMarkerByLineIndex(int iMarkerType, int iStartingLine, int iStartingIndex, unsigned int dwFlags, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsTextLineMarker ^ &  ppMarker);

int FindMarkerByLineIndex(int iMarkerType, int iStartingLine, int iStartingIndex, unsigned int dwFlags, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsTextLineMarker const & & ppMarker);

public int FindMarkerByLineIndex (int iMarkerType, int iStartingLine, int iStartingIndex, uint dwFlags, out Microsoft.VisualStudio.TextManager.Interop.IVsTextLineMarker ppMarker);

abstract member FindMarkerByLineIndex : int * int * int * uint32 * IVsTextLineMarker -> int

Public Function FindMarkerByLineIndex (iMarkerType As Integer, iStartingLine As Integer, iStartingIndex As Integer, dwFlags As UInteger, ByRef ppMarker As IVsTextLineMarker) As Integer

Parameters

iMarkerType

Int32

[in] Specifies the type of marker to find.

iStartingLine

Int32

[in] Starting line.

iStartingIndex

Int32

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

dwFlags

UInt32

[in] Specifies the direction to search for the marker. For a list of dwFlags values, see FINDMARKERFLAGS.

ppMarker

IVsTextLineMarker

[out] Pointer to the IVsTextLineMarker interface (that is, the text marker).

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::FindMarkerByLineIndex(  
   [in] long iMarkerType,  
   [in] long iStartingLine,  
   [in] CharIndex iStartingIndex,  
   [in] DWORD dwFlags,  
   [out] IVsTextLineMarker **ppMarker  
);  

This method searches for markers subject to the constraints specified using the dwFlags and iMarkerType parameters.