IUIAutomation::PollForPotentialSupportedPatterns method (uiautomationclient.h)

Article
02/22/2024

Retrieves the control patterns that might be supported on a UI Automation element.

Syntax

HRESULT PollForPotentialSupportedPatterns(
  [in]  IUIAutomationElement *pElement,
  [out] SAFEARRAY            **patternIds,
  [out] SAFEARRAY            **patternNames
);

Parameters

[in] pElement

Type: IUIAutomationElement*

The address of the element to poll.

[out] patternIds

Type: SAFEARRAY(int)**

Receives a pointer to an array of control pattern identifiers.

[out] patternNames

Type: SAFEARRAY(BSTR)**

Receives a pointer to an array of control pattern names.

Return value

Type: HRESULT

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

Remarks

This method is intended only for use by Microsoft UI Automation tools that need to scan for properties. It is not intended to be used by UI Automation clients.

There is no guarantee that the element will support any particular control pattern when asked for it later.

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)