IUIAutomation::PollForPotentialSupportedProperties method

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

Syntax


HRESULT PollForPotentialSupportedProperties(
  [in]  IUIAutomationElement *pElement,
  [out] SAFEARRAY(int)       **propertyIds,
  [out] SAFEARRAY(BSTR)      **propertyNames
);

Parameters

pElement [in]

Type: IUIAutomationElement*

The address of the UI Automation element to poll.

propertyIds [out]

Type: SAFEARRAY(int)**

Receives a pointer to an array of property identifiers. For a list of property IDs, see Property Identifiers.

propertyNames [out]

Type: SAFEARRAY(BSTR)**

Receives a pointer to an array of property 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 and control patterns. It is not intended to be used by UI Automation clients.

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

Requirements

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]

Header

UIAutomationClient.h (include UIAutomation.h)

IDL

UIAutomationClient.idl

See also

Reference
PollForPotentialSupportedPatterns
IUIAutomation
Conceptual
Custom Properties, Events, and Control Patterns
Best Practices for Using Safe Arrays

 

 

Show: