IUIAutomation::PollForPotentialSupportedPatterns Method

  • Article

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

Syntax

HRESULT PollForPotentialSupportedPatterns(      
    IUIAutomationElement *pElement,
    SAFEARRAY(int) *patternIds,
    SAFEARRAY(BSTR) *patternNames
);

Parameters

  • pElement
    [in] The address of the IUIAutomationElement interface of the element to poll.
  • patternIds
    [out] The address of a SAFEARRAY that receives a pointer to an array of control pattern identifiers.
  • patternNames
    [out] The address of a SAFEARRAY that receives a pointer to an array of control pattern names.

Return Value

Returns S_OK if successful, or an error value otherwise.

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.

See Also

Custom Properties, Events, and Control Patterns, IUIAutomation::PollForPotentialSupportedProperties, IUIAutomation, Working with Safe Arrays