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(
  _In_  HUIATEXTRANGE   hobj,
  _In_  TEXTATTRIBUTEID attributeId,
  _In_  VARIANT         val,
  _In_  BOOL            backward,
  _Out_ HUITEXTRANGE    *pRetVal
);

Parameters

hobj [in]

Type: HUIATEXTRANGE

The text range to search.

attributeId [in]

Type: TEXTATTRIBUTEID

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

val [in]

Type: VARIANT

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

backward [in]

Type: BOOL

TRUE to search backward, otherwise FALSE.

pRetVal [out]

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]

Header

UIAutomationCoreApi.h

Library

Uiautomationcore.lib

DLL

Uiautomationcore.dll

 

 

Show: