Edit

Share via

IUIAutomationPatternInstance::GetProperty method (uiautomationcore.h)

  • Article

The client wrapper object implements the IUIAutomation::get_CurrentX and IUIAutomationElement::get_CachedX methods by calling this function, specifying the property by index.

Syntax

HRESULT GetProperty(
  [in]          UINT             index,
  [in]          BOOL             cached,
  [in]          UIAutomationType type,
  [out, retval] void             *pPtr
);

Parameters

[in] index

Type: UINT

The index of the property.

[in] cached

Type: BOOL

TRUE if the property should be retrieved from the cache, otherwise FALSE.

[in] type

Type: UIAutomationType

A value indicating the data type of the property.

[out, retval] pPtr

Type: void*

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.

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 | UWP apps]
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 | UWP apps]
Target Platform Windows
Header uiautomationcore.h (include UIAutomation.h)

See also

IUIAutomationPatternInstance