IVsTextStream.EnumMarkers Method

Article
11/19/2013

Enumerates s specific set of text stream 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 ( _
    iPos As Integer, _
    iLen As Integer, _
    iMarkerType As Integer, _
    dwFlags As UInteger, _
    <OutAttribute> ByRef ppEnum As IVsEnumStreamMarkers _
) As Integer

int EnumMarkers(
    int iPos,
    int iLen,
    int iMarkerType,
    uint dwFlags,
    out IVsEnumStreamMarkers ppEnum
)

int EnumMarkers(
    [InAttribute] int iPos, 
    [InAttribute] int iLen, 
    [InAttribute] int iMarkerType, 
    [InAttribute] unsigned int dwFlags, 
    [OutAttribute] IVsEnumStreamMarkers^% ppEnum
)

abstract EnumMarkers : 
        iPos:int * 
        iLen:int * 
        iMarkerType:int * 
        dwFlags:uint32 * 
        ppEnum:IVsEnumStreamMarkers byref -> int

function EnumMarkers(
    iPos : int, 
    iLen : int, 
    iMarkerType : int, 
    dwFlags : uint, 
    ppEnum : IVsEnumStreamMarkers
) : int

Parameters

iPos
Type: System.Int32

[in] Starting position in the text buffer.

iLen
Type: System.Int32

[in] Length of text to enumerate marker over.

iMarkerType
Type: System.Int32

[in] Type of markers to enumerate. This parameter is ignored if a value of EM_ALLTYPES is specified for the dwFlags parameter.

dwFlags
Type: System.UInt32

[in] Enumeration options. For a list of dwFlags values, see ENUMMARKERFLAGS.

ppEnum
Type: Microsoft.VisualStudio.TextManager.Interop.IVsEnumStreamMarkers%

[out] Pointer to the IVsEnumStreamMarkers 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 IVsTextStream::EnumMarkers(
   [in] long iPos,
   [in] long iLen,
   [in] long iMarkerType,
   [in] DWORD dwFlags,
   [out] IVsEnumStreamMarkers **ppEnum
);

This method enumerates the markers over a given region, subject to the value(s) of the dwFlags parameter. EnumMarkers enumerates all markers, but gets the IVsTextStreamMarker interface via the IVsEnumStreamMarkers 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.

Share via