IVsTextLines::EnumMarkers Method (Int32, Int32, Int32, Int32, Int32, UInt32, IVsEnumLineMarkers^)

Visual Studio 2015

Enumerates a specific set of text line markers, based on the criteria specified.

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

Syntax

C++

int EnumMarkers(
	int iStartLine,
	int iStartIndex,
	int iEndLine,
	int iEndIndex,
	int iMarkerType,
	unsigned int dwFlags,
	[OutAttribute] IVsEnumLineMarkers^% ppEnum
)

Parameters

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

iStartIndex: Type: System::Int32
[in] Starting character index within the line. 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. Must be less than or equal to the length of the line.

iMarkerType: Type: System::Int32
[in] This parameter is ignored if a value of EM_ALLTYPES is specified for the dwFlags parameter. Otherwise, this parameter indicates the marker type to find.

dwFlags: Type: System::UInt32
[in] Enumeration options. For a list of dwFlags values, see ENUMMARKERFLAGS.

ppEnum: Type: Microsoft.VisualStudio.TextManager.Interop::IVsEnumLineMarkers^
[out] Pointer to the IVsEnumLineMarkers interface.

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:

C++

HRESULT IVsTextLines::EnumMarkers(
   [in] long iStartLine,
   [in] CharIndex iStartIndex,
   [in] long iEndLine,
   [in] CharIndex iEndIndex,
   [in] long iMarkerType,
   [in] DWORD dwFlags,
   [out] IVsEnumLineMarkers ** ppEnum
);

This method enumerates the markers over a given region, subject to the value of the dwFlags parameter. IVsTextLines.EnumMarkers enumerates all markers, but gets their IVsTextLineMarker interface via the IVsEnumLineMarkers interface.