Share via


ITextRangeProvider::FindText Method

Returns a text range subset that contains the specified text.

Syntax

HRESULT FindText(      
    BSTR text,
    BOOL backward,
    BOOL ignoreCase,
    ITextRangeProvider **pRetVal
);

Parameters

  • text
    [in] A BSTR that contains the text string to search for.
  • backward
    [in] TRUE if the last occurring text range should be returned instead of the first; otherwise FALSE.
  • ignoreCase
    [in] TRUE if case should be ignored; otherwise FALSE.
  • pRetVal
    [out, retval] The address of a variable that receives a pointer to the ITextRangeProvider interface of the text range matching the specified text; otherwise NULL. This parameter is passed uninitialized.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

There is no differentiation between hidden and visible text.

See Also

UI Automation Providers Overview, ITextProvider