IVsSyntheticTextSession.EnumSyntheticRegions Method

Article
05/06/2010

Returns a static snapshot list of synthetic regions.

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

Syntax

'Déclaration
Function EnumSyntheticRegions ( _
    dwFindFlags As UInteger, _
    dwCookie As UInteger, _
    ptsRange As TextSpan(), _
    <OutAttribute> ByRef ppEnum As IVsEnumSyntheticRegions _
) As Integer
'Utilisation
Dim instance As IVsSyntheticTextSession
Dim dwFindFlags As UInteger
Dim dwCookie As UInteger
Dim ptsRange As TextSpan()
Dim ppEnum As IVsEnumSyntheticRegions
Dim returnValue As Integer

returnValue = instance.EnumSyntheticRegions(dwFindFlags, _
    dwCookie, ptsRange, ppEnum)

int EnumSyntheticRegions(
    uint dwFindFlags,
    uint dwCookie,
    TextSpan[] ptsRange,
    out IVsEnumSyntheticRegions ppEnum
)

int EnumSyntheticRegions(
    [InAttribute] unsigned int dwFindFlags, 
    [InAttribute] unsigned int dwCookie, 
    [InAttribute] array<TextSpan>^ ptsRange, 
    [OutAttribute] IVsEnumSyntheticRegions^% ppEnum
)

abstract EnumSyntheticRegions : 
        dwFindFlags:uint32 * 
        dwCookie:uint32 * 
        ptsRange:TextSpan[] * 
        ppEnum:IVsEnumSyntheticRegions byref -> int

function EnumSyntheticRegions(
    dwFindFlags : uint, 
    dwCookie : uint, 
    ptsRange : TextSpan[], 
    ppEnum : IVsEnumSyntheticRegions
) : int

Parameters

dwFindFlags
Type: System.UInt32
[in] Indicates how to find the region. For values of dwFindFlags see the FIND_SYNTHETIC_REGION_FLAGS enumeration.

dwCookie
Type: System.UInt32
[in] Additional search parameter; can be used to search for a specific client DWORD.

ptsRange
Type: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]
[in] Search parameter for finding text.

ppEnum
Type: Microsoft.VisualStudio.TextManager.Interop.IVsEnumSyntheticRegions%
[out] The resulting enumeration.

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 IVsSyntheticTextSession::EnumSyntheticRegions(
   [in] DWORD dwFindFlags,
   [in] DWORD_PTR dwCookie,
   [in] TextSpan *ptsRange,
   [out] IVsEnumSyntheticRegions **ppEnum
);

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