Partager via


IVsFindTarget.GetSearchImage(UInt32, IVsTextSpanSet[], IVsTextImage) Method

Definition

Returns a text image for the environment to search.

public:
 int GetSearchImage(System::UInt32 grfOptions, cli::array <Microsoft::VisualStudio::TextManager::Interop::IVsTextSpanSet ^> ^ ppSpans, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsTextImage ^ % ppTextImage);
public:
 int GetSearchImage(unsigned int grfOptions, Platform::Array <Microsoft::VisualStudio::TextManager::Interop::IVsTextSpanSet ^> ^ ppSpans, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsTextImage ^ &  ppTextImage);
int GetSearchImage(unsigned int grfOptions, std::Array <Microsoft::VisualStudio::TextManager::Interop::IVsTextSpanSet const &> const & ppSpans, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsTextImage const & & ppTextImage);
public int GetSearchImage (uint grfOptions, Microsoft.VisualStudio.TextManager.Interop.IVsTextSpanSet[] ppSpans, out Microsoft.VisualStudio.TextManager.Interop.IVsTextImage ppTextImage);
abstract member GetSearchImage : uint32 * Microsoft.VisualStudio.TextManager.Interop.IVsTextSpanSet[] * IVsTextImage -> int
Public Function GetSearchImage (grfOptions As UInteger, ppSpans As IVsTextSpanSet(), ByRef ppTextImage As IVsTextImage) As Integer

Parameters

grfOptions
UInt32

[in] Specifies Find and Replace options. For a list of values, see __VSFINDOPTIONS.

ppSpans
IVsTextSpanSet[]

[out] The set of text spans as pointer to the IVsTextSpanSet interface.

ppTextImage
IVsTextImage

[out, retval] The text image as pointer to the IVsTextImage interface

Returns

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:

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.

Applies to