IUIAutomationTextRange::FindText method

Retrieves a text range subset that contains the specified text.

Syntax


HRESULT FindText(
  [in]           BSTR text,
  [in]           BOOL backward,
  [in]           BOOL ignoreCase,
  [out, retval]  IUIAutomationTextRange **found
);

Parameters

text [in]

Type: BSTR

The text to find.

backward [in]

Type: BOOL

TRUE if the last occurring text range should be returned instead of the first; otherwise FALSE.

ignoreCase [in]

Type: BOOL

TRUE if case should be ignored; otherwise FALSE.

found [out, retval]

Type: IUIAutomationTextRange**

Receives a pointer to the text range, or NULL if no match is found.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

There is no differentiation between hidden and visible text.

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista, Windows XP with SP3 and Platform Update for Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008, Windows Server 2003 with SP2 and Platform Update for Windows Server 2008 [desktop apps only]

Header

UIAutomationClient.h (include UIAutomation.h)

IDL

UIAutomationClient.idl

See also

IUIAutomationTextRange
UI Automation Support for Textual Content

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.