IVsHiddenTextSession.EnumHiddenRegions Method

2012-09-25

Returns a list of the current hidden regions.

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

Syntax

'Declaration
Function EnumHiddenRegions ( _
    dwFindFlags As UInteger, _
    dwCookie As UInteger, _
    ptsRange As TextSpan(), _
    <OutAttribute> ByRef ppEnum As IVsEnumHiddenRegions _
) As Integer

'Usage
Dim instance As IVsHiddenTextSession 
Dim dwFindFlags As UInteger 
Dim dwCookie As UInteger 
Dim ptsRange As TextSpan()
Dim ppEnum As IVsEnumHiddenRegions 
Dim returnValue As Integer 

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

int EnumHiddenRegions(
    uint dwFindFlags,
    uint dwCookie,
    TextSpan[] ptsRange,
    out IVsEnumHiddenRegions ppEnum
)

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

function EnumHiddenRegions(
    dwFindFlags : uint, 
    dwCookie : uint, 
    ptsRange : TextSpan[], 
    ppEnum : IVsEnumHiddenRegions
) : int

Parameters

dwFindFlags
Type: System.UInt32

[in] Options for finding hidden regions. For more information, see FIND_HIDDEN_REGION_FLAGS.

dwCookie
Type: System.UInt32

[in] Specifies the client-defined hidden region type to find. Specify a value that matches the client-defined identifier specified during the creation of the new hidden region (that is, the dwClient member in the NewHiddenRegion structure).

ptsRange
Type: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]

[in] Specifies the range of text over which to enumerate the hidden regions.

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

[out] Pointer to an IVsEnumHiddenRegions object that is used to enumerate hidden regions of specified type over the specified range in the text buffer.

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

IVsHiddenTextSession.EnumHiddenRegions returns a static snapshot list of hidden regions. There is a variety of Find options that you can specify, based on the value of the dwFindFlags parameter. These options include finding all regions, finding regions of a type matching that specified in the dwCookie parameter, and finding hidden regions that intersect or are fully contained by a particular span of text. For more information on the available options, see FIND_HIDDEN_REGION_FLAGS.

.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