Edit

Share via

IUIAutomationElement::GetCurrentPropertyValue method (uiautomationclient.h)

Retrieves the current value of a property for this UI Automation element.

Syntax

HRESULT GetCurrentPropertyValue(
  [in]          PROPERTYID propertyId,
  [out, retval] VARIANT    *retVal
);

Parameters

[in] propertyId

Type: PROPERTYID

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

[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

Microsoft 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

GetCachedPropertyValue

GetCurrentPropertyValueEx

IUIAutomationElement

Reference

UI Automation Properties Overview