UiaRaiseNotificationEvent function

Called by providers to initiate a notification event.

Syntax

HRESULT UiaRaiseNotificationEvent(
  IRawElementProviderSimple *provider,
  NotificationKind          notificationKind,
  NotificationProcessing    notificationProcessing,
  BSTR                      displayString,
  BSTR                      activityId
);

Parameters

provider

The provider node where the notification event occurred.

notificationKind

The type of notification, as a NotificationKind enumeration value.

notificationProcessing

The preferred way to process a notification, as a NotificationProcessing enumeration value.

displayString

A string to display in the notification message.

activityId

A unique non-localized string to identify an action or group of actions. Use this to pass additional information to the event handler.

Return value

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

Requirements

   
Minimum supported client Windows 10, version 1709 [desktop apps | UWP apps]
Minimum supported server Windows Server 2016 [desktop apps | UWP apps]
Target Platform Windows
Header uiautomationcoreapi.h (include UIAutomation.h)
Library Uiautomationcore.lib
DLL Uiautomationcore.dll