XGameUiSetNotificationPositionHint

Sets the preferred position for toast notifications to be shown on the current title.

Syntax

HRESULT XGameUiSetNotificationPositionHint(  
         XGameUiNotificationPositionHint position  
)  

Parameters

position   _In_
Type: XGameUiNotificationPositionHint

Indicates the preferred position to display toast notifications on the current title.

Return value

Type: HRESULT

Remarks

Note

This function isn't safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.

The notification position is a hint to the operating system on where to display toast notifications. In some cases, the system may choose to ignore the setting if the current UI cannot support displaying notifications in that location. By default on Xbox, toast notifications are shown at the bottom center of the screen.

This API exists on Windows, however it currently has no effect on achievement and other toast notifications.

Requirements

Header: XGameUI.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

XGameUI
XGameUiNotificationPositionHint