Delen via


IVsFindTarget.GetSearchImage Method

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

'Declaration
Function GetSearchImage ( _
    grfOptions As UInteger, _
    <OutAttribute> ppSpans As IVsTextSpanSet(), _
    <OutAttribute> ByRef ppTextImage As IVsTextImage _
) As Integer
int GetSearchImage(
    uint grfOptions,
    IVsTextSpanSet[] ppSpans,
    out IVsTextImage ppTextImage
)
int GetSearchImage(
    [InAttribute] unsigned int grfOptions, 
    [OutAttribute] array<IVsTextSpanSet^>^ ppSpans, 
    [OutAttribute] IVsTextImage^% ppTextImage
)
abstract GetSearchImage : 
        grfOptions:uint32 * 
        ppSpans:IVsTextSpanSet[] byref * 
        ppTextImage:IVsTextImage byref -> int
function GetSearchImage(
    grfOptions : uint, 
    ppSpans : IVsTextSpanSet[], 
    ppTextImage : IVsTextImage
) : int

Parameters

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:

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.

.NET Framework Security

See Also

Reference

IVsFindTarget Interface

Microsoft.VisualStudio.TextManager.Interop Namespace