IUIAutomationElement::GetCurrentPropertyValueEx method (uiautomationclient.h)
Retrieves a property value for this UI Automation element, optionally ignoring any default value.
Syntax
HRESULT GetCurrentPropertyValueEx(
[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 property value.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
Passing FALSE in the ignoreDefaultValue parameter is equivalent to calling IUIAutomationElement::GetCurrentPropertyValue.
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
| 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) |
See also
Conceptual
Reference