TextRange_FindAttribute function

Note  This function is deprecated. Client applications should use the Microsoft UI Automation Component Object Model (COM) interfaces instead.
 
Searches in a specified direction for the first piece of text supporting a specified text attribute.

Syntax

HRESULT TextRange_FindAttribute(
  HUIATEXTRANGE   hobj,
  TEXTATTRIBUTEID attributeId,
  VARIANT         val,
  BOOL            backward,
  HUIATEXTRANGE   *pRetVal
);

Parameters

hobj

Type: HUIATEXTRANGE

The text range to search.

attributeId

Type: TEXTATTRIBUTEID

The text attribute to search for. For a list of text attribute IDs, see Text Attribute Identifiers.

val

Type: VARIANT

The value of the attribute that the client wants to find.

backward

Type: BOOL

TRUE to search backward, otherwise FALSE.

pRetVal

Type: HUITEXTRANGE*

When this function returns, contains the first matching text range. This parameter is passed uninitialized.

Return Value

Type: HRESULT

Returns S_OK if successful or an error value otherwise.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header uiautomationcoreapi.h
Library Uiautomationcore.lib
DLL Uiautomationcore.dll