IVsFindTarget::GetSearchImage Method (UInt32, array<IVsTextSpanSet^>^, IVsTextImage^)

Visual Studio 2015

Returns a text image for the environment to search.

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

Syntax

C++

int GetSearchImage(
	unsigned int grfOptions,
	array<IVsTextSpanSet^>^ ppSpans,
	[OutAttribute] IVsTextImage^% ppTextImage
)

Parameters

grfOptions: Type: System::UInt32
[in] Specifies Find and Replace options. For a list of values, see __VSFINDOPTIONS.

ppSpans: Type: array<Microsoft.VisualStudio.TextManager.Interop::IVsTextSpanSet^>^
[out] The set of text spans as pointer to the IVsTextSpanSet interface.

ppTextImage: Type: Microsoft.VisualStudio.TextManager.Interop::IVsTextImage^
[out, retval] The text image as pointer to the IVsTextImage interface

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

Implement either GetSearchImage method or Find and Replace methods.

COM Signature

From textmgr.idl:

C++

HRESULT IVsFindTarget::GetSearchImage(
   [in] VSFINDOPTIONS grfOptions,
   [out, custom(DE89D360-C06A-11d2-936C-D714766E8B50,"optional")] IVsTextSpanSet ** ppSpans
);

To support searching, you must implement either GetSearchImage or Find and Replace.