IUIAutomationElement::GetCachedPropertyValueEx メソッド (uiautomationclient.h)

必要に応じて既定値を無視して、このUI オートメーション要素のキャッシュからプロパティ値を取得します。

構文

HRESULT GetCachedPropertyValueEx(
  [in]          PROPERTYID propertyId,
  [in]          BOOL       ignoreDefaultValue,
  [out, retval] VARIANT    *retVal
);

パラメーター

[in] propertyId

型: PROPERTYID

プロパティの識別子。 プロパティ ID の一覧については、「 プロパティ識別子」を参照してください。

[in] ignoreDefaultValue

種類: BOOL

指定したプロパティがサポートされていない場合は既定値を無視するかどうかを示す値です。既定値が返されない場合は TRUE 、返される場合は FALSE です。

[out, retval] retVal

型: VARIANT*

プロパティの値を受け取ります。

戻り値

型: HRESULT

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

注釈

このメソッドは、UI オートメーション要素のキャッシュから指定されたプロパティを取得します。 現在のプロパティを取得するには、 IUIAutomationElement::GetCurrentPropertyValueEx を呼び出します。

ignoreDefaultValue パラメーターで FALSE を渡すことは、IUIAutomationElement::GetCachedPropertyValue を呼び出すことと同じです。

要素自体の Microsoft UI オートメーション プロバイダーが プロパティをサポートしている場合は、 プロパティの値が返されます。 それ以外の場合、ignoreDefaultValue が FALSE の場合は、UI オートメーションで指定された既定値が返されます。

要求されたプロパティが以前にキャッシュされていない場合、このメソッドはエラー コードを返します。

double 型のUI オートメーションプロパティは、Not a Number (NaN) 値をサポートします。 double 型のプロパティを取得する場合、クライアントは _isnan 関数を使用して、プロパティが NaN 値であるかどうかを判断できます。

要件

要件	値
サポートされている最小のクライアント	Windows 7、Windows Vista SP2 と Windows Vista 用プラットフォーム更新プログラム、WINDOWS XP SP3 と Windows Vista 用プラットフォーム更新プログラム [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム、WINDOWS Server 2003 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	uiautomationclient.h (UIAutomation.h を含む)

関連項目

概念

GetCachedPropertyValue

GetCurrentPropertyValueEx

IUIAutomationElement

リファレンス

UI オートメーション プロパティの概要