Edit

Share via

TextRange_GetAttributeValue function (uiautomationcoreapi.h)

  • Article
Note  This function is deprecated. Client applications should use the Microsoft UI Automation Component Object Model (COM) interfaces instead.
 
Gets the value of a text attribute for a text range.

Syntax

HRESULT TextRange_GetAttributeValue(
  [in]  HUIATEXTRANGE   hobj,
  [in]  TEXTATTRIBUTEID attributeId,
  [out] VARIANT         *pRetVal
);

Parameters

[in] hobj

Type: HUIATEXTRANGE

A text range object.

[in] attributeId

Type: TEXTATTRIBUTEID

The text attribute whose value is wanted. For a list of text attribute IDs, see Text Attribute Identifiers.

[out] pRetVal

Type: VARIANT*

When this function returns, contains the value of the attribute for the text range. This parameter is passed uninitialized.

Return value

Type: HRESULT

Returns S_OK if successful or an error value otherwise.

Requirements

Requirement Value
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