IVsTextLines.EnumMarkers Method

Article
09/25/2012

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

'Declaration
Function EnumMarkers ( _
    iStartLine As Integer, _
    iStartIndex As Integer, _
    iEndLine As Integer, _
    iEndIndex As Integer, _
    iMarkerType As Integer, _
    dwFlags As UInteger, _
    <OutAttribute> ByRef ppEnum As IVsEnumLineMarkers _
) As Integer

'Usage
Dim instance As IVsTextLines 
Dim iStartLine As Integer 
Dim iStartIndex As Integer 
Dim iEndLine As Integer 
Dim iEndIndex As Integer 
Dim iMarkerType As Integer 
Dim dwFlags As UInteger 
Dim ppEnum As IVsEnumLineMarkers 
Dim returnValue As Integer 

returnValue = instance.EnumMarkers(iStartLine, _
    iStartIndex, iEndLine, iEndIndex, _
    iMarkerType, dwFlags, ppEnum)

int EnumMarkers(
    int iStartLine,
    int iStartIndex,
    int iEndLine,
    int iEndIndex,
    int iMarkerType,
    uint dwFlags,
    out IVsEnumLineMarkers ppEnum
)

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

function EnumMarkers(
    iStartLine : int, 
    iStartIndex : int, 
    iEndLine : int, 
    iEndIndex : int, 
    iMarkerType : int, 
    dwFlags : uint, 
    ppEnum : IVsEnumLineMarkers
) : int

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:

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.

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