Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IUIAutomationRegistrar::RegisterPattern method

Registers a third-party control pattern.

Syntax


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

Parameters

pattern [in]

Type: UIAutomationPatternInfo*

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

patternId [out]

Type: PATTERNID*

Receives the pattern identifier.

pPatternAvailablePropertyId [out]

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.

propertyIdCount [in]

Type: UINT

The number of properties supported by the control pattern.

pPropertyIds [out]

Type: PROPERTYID*

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

eventIdCount [in]

Type: UINT

The number of events supported by the control pattern.

pEventIds [out]

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

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 | Windows Store 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 | Windows Store apps]

Header

UIAutomationCore.h (include UIAutomation.h)

IDL

UIAutomationClient.idl

See also

IUIAutomationRegistrar

 

 

Community Additions

Show:
© 2014 Microsoft