UiaRaiseNotificationEvent function (uiautomationcoreapi.h)
Called by providers to initiate a notification event.
Syntax
HRESULT UiaRaiseNotificationEvent(
[in] IRawElementProviderSimple *provider,
NotificationKind notificationKind,
NotificationProcessing notificationProcessing,
[in, optional] BSTR displayString,
[in] BSTR activityId
);
Parameters
[in] 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.
[in, optional] displayString
A string to display in the notification message.
[in] 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.
Remarks
If your window uses the WS_POPUP
style, it must also implement the Window Control Pattern and handle the WM_GETOBJECT message (see How to Expose a Server-Side UI Automation Provider for more details).
Requirements
Requirement | Value |
---|---|
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 |