IUIAutomationTextRange::FindAttribute method (uiautomationclient.h)
Retrieves a text range subset that has the specified text attribute value.
Syntax
HRESULT FindAttribute(
[in] TEXTATTRIBUTEID attr,
[in] VARIANT val,
[in] BOOL backward,
[out, retval] IUIAutomationTextRange **found
);
Parameters
[in] attr
Type: TEXTATTRIBUTEID
The identifier of the text attribute for the text range subset being retrieved. For a list of text attribute IDs, see Text Attribute Identifiers.
[in] val
Type: VARIANT
The value of the attribute. This value must match the type specified for the attribute.
[in] backward
Type: BOOL
TRUE if the last occurring text range should be returned instead of the first; otherwise FALSE.
[out, retval] found
Type: IUIAutomationTextRange**
Receives a pointer to the text range having a matching attribute and attribute value; otherwise NULL.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
The FindAttribute method retrieves matching text regardless of whether the text is hidden or visible. Use UIA_IsHiddenAttributeId to check text visibility.
Requirements
| Requirement | Value |
|---|---|
| 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] |
| Target Platform | Windows |
| Header | uiautomationclient.h (include UIAutomation.h) |