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
'Usage
Dim instance As IVsFindTarget
Dim grfOptions As UInteger
Dim ppSpans As IVsTextSpanSet()
Dim ppTextImage As IVsTextImage
Dim returnValue As Integer

returnValue = instance.GetSearchImage(grfOptions, _
    ppSpans, ppTextImage)

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

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] Pointer to the IVsTextSpanSet interface.

ppTextImage
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextImage%

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

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.