IUIAutomationElement::GetCachedPropertyValueEx method (uiautomationclient.h)

Retrieves a property value from the cache for this UI Automation element, optionally ignoring any default value.

Syntax

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

Parameters

[in] propertyId

Type: PROPERTYID

The identifier of the property. For a list of property IDs, see Property Identifiers.

[in] ignoreDefaultValue

Type: BOOL

A value that specifies whether a default value should be ignored if the specified property is not supported: TRUE if the default value is not to be returned, or FALSE if it is to be returned.

[out, retval] retVal

Type: VARIANT*

Receives the value of the property.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method retrieves the specified property from the cache for the UI Automation element. To retrieve the current property, call IUIAutomationElement::GetCurrentPropertyValueEx.

Passing FALSE in the ignoreDefaultValue parameter is equivalent to calling IUIAutomationElement::GetCachedPropertyValue.

If the Microsoft UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, if ignoreDefaultValue is FALSE, a default value specified by UI Automation is returned.

This method returns a failure code if the requested property was not previously cached.

UI Automation properties of the double type support Not a Number (NaN) values. When retrieving a property of the double type, a client can use the _isnan function to determine whether the property is a NaN value.

Requirements

See also

Conceptual

GetCachedPropertyValue

GetCurrentPropertyValueEx

IUIAutomationElement

Reference

UI Automation Properties Overview