ITextRangeProvider::GetAttributeValue メソッド (uiautomationcore.h)

指定したテキスト属性の値をテキスト範囲全体で取得します。

構文

HRESULT GetAttributeValue(
  [in]          TEXTATTRIBUTEID attributeId,
  [out, retval] VARIANT         *pRetVal
);

パラメーター

[in] attributeId

型: TEXTATTRIBUTEID

テキスト属性の識別子。 テキスト属性 ID の一覧については、「 テキスト属性識別子」を参照してください。

[out, retval] pRetVal

型: VARIANT*

次のいずれかを受け取ります。

  • 指定した属性の値を表すオブジェクトのアドレス。 値のデータ型は、指定した属性によって異なります。 たとえば、 attributeIdUIA_FontNameAttributeId場合、 GetAttributeValue はテキスト範囲のフォント名を表す文字列を返しますが、 attributeIdUIA_IsItalicAttributeId場合、 GetAttributeValue はブール値を返します。
  • 指定した属性の値がテキスト範囲で変化する場合に、 UiaGetReservedMixedAttributeValue 関数によって取得される値のアドレス。
  • 指定した属性がプロバイダーまたはコントロールでサポートされていない場合に、 UiaGetReservedNotSupportedValue 関数によって取得される値のアドレス。
このパラメーターは初期化せずに渡されます。

戻り値

種類: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

解説

GetAttributeValue メソッドは、テキストが非表示か表示かに関係なく、属性値を取得する必要があります。

要件

   
サポートされている最小のクライアント Windows XP [デスクトップ アプリ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー uiautomationcore.h (UIAutomation.h を含む)

関連項目

概念

ITextProvider

ITextRangeProvider

リファレンス

UI オートメーション プロバイダーの概要