Edit

Share via

IUIAutomationRegistrar::RegisterPattern method (uiautomationcore.h)

  • Article

Registers a third-party control pattern.

Syntax

HRESULT RegisterPattern(
  [in]  const UIAutomationPatternInfo *pattern,
  [out] PATTERNID                     *pPatternId,
  [out] PROPERTYID                    *pPatternAvailablePropertyId,
  [in]  UINT                          propertyIdCount,
  [out] PROPERTYID                    *pPropertyIds,
  [in]  UINT                          eventIdCount,
  [out] EVENTID                       *pEventIds
);

Parameters

[in] pattern

Type: UIAutomationPatternInfo*

A pointer to a structure that contains information about the control pattern to register.

[out] pPatternId

Type: PATTERNID*

Receives the pattern identifier.

[out] pPatternAvailablePropertyId

Type: PROPERTYID*

Receives the property identifier for the pattern. This value can be used with UI Automation client methods to determine whether the element supports the new pattern. This is equivalent to values such as UIA_IsInvokePatternAvailablePropertyId.

[in] propertyIdCount

Type: UINT

The number of properties supported by the control pattern.

[out] pPropertyIds

Type: PROPERTYID*

Receives an array of identifiers for properties supported by the pattern.

[in] eventIdCount

Type: UINT

The number of events supported by the control pattern.

[out] pEventIds

Type: EVENTID*

Receives an array of identifiers for events that are raised by the pattern.

Return value

Type: HRESULT

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

Remarks

The pattern, property, and event IDs retrieved by this method can be used in IAccessibleEx implementations.

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

IUIAutomationRegistrar