Partager via


IVsHiddenTextSession.EnumHiddenRegions Method

Definition

Overloads

EnumHiddenRegions(UInt32, IntPtr, TextSpan[], IVsEnumHiddenRegions)
EnumHiddenRegions(UInt32, UInt32, TextSpan[], IVsEnumHiddenRegions)

Returns a list of the current hidden regions.

EnumHiddenRegions(UInt32, IntPtr, TextSpan[], IVsEnumHiddenRegions)

public:
 int EnumHiddenRegions(System::UInt32 dwFindFlags, IntPtr filterData, cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ ptsRange, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsEnumHiddenRegions ^ % ppEnum);
public int EnumHiddenRegions (uint dwFindFlags, IntPtr filterData, Microsoft.VisualStudio.TextManager.Interop.TextSpan[] ptsRange, out Microsoft.VisualStudio.TextManager.Interop.IVsEnumHiddenRegions ppEnum);
abstract member EnumHiddenRegions : uint32 * nativeint * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] * IVsEnumHiddenRegions -> int
Public Function EnumHiddenRegions (dwFindFlags As UInteger, filterData As IntPtr, ptsRange As TextSpan(), ByRef ppEnum As IVsEnumHiddenRegions) As Integer

Parameters

dwFindFlags
UInt32
filterData
IntPtr

nativeint

ptsRange
TextSpan[]

Returns

Applies to

EnumHiddenRegions(UInt32, UInt32, TextSpan[], IVsEnumHiddenRegions)

Returns a list of the current hidden regions.

public:
 int EnumHiddenRegions(System::UInt32 dwFindFlags, System::UInt32 dwCookie, cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ ptsRange, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsEnumHiddenRegions ^ % ppEnum);
public:
 int EnumHiddenRegions(unsigned int dwFindFlags, unsigned int dwCookie, Platform::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ ptsRange, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsEnumHiddenRegions ^ &  ppEnum);
int EnumHiddenRegions(unsigned int dwFindFlags, unsigned int dwCookie, std::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> const & ptsRange, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsEnumHiddenRegions const & & ppEnum);
public int EnumHiddenRegions (uint dwFindFlags, uint dwCookie, Microsoft.VisualStudio.TextManager.Interop.TextSpan[] ptsRange, out Microsoft.VisualStudio.TextManager.Interop.IVsEnumHiddenRegions ppEnum);
abstract member EnumHiddenRegions : uint32 * uint32 * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] * IVsEnumHiddenRegions -> int
Public Function EnumHiddenRegions (dwFindFlags As UInteger, dwCookie As UInteger, ptsRange As TextSpan(), ByRef ppEnum As IVsEnumHiddenRegions) As Integer

Parameters

dwFindFlags
UInt32

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

dwCookie
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
TextSpan[]

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

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

Returns

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.

Applies to