XGameUiShowErrorDialogAsync

Article
06/22/2023

Displays UI for an error dialog with a service defined error string for the specified error code.

Syntax

HRESULT XGameUiShowErrorDialogAsync(  
         XAsyncBlock* async,  
         HRESULT errorCode,  
         const char* context  
)

Parameters

async _In_
Type: XAsyncBlock*

A pointer to the XAsyncBlock that is passed to XAsyncRun.

errorCode _In_
Type: HRESULT

The error code to display the UI for.

context _In_opt_
Type: char*

The service defined error string to display for the error.

Return value

Type: HRESULT

HRESULT success or error code of the async call.

Remarks

Additional buttons may appear on the dialog as appropriate, for example "Report a Problem" for Xbox Insiders to allow for bugs to be reported.

The async operation completes when the user dismisses the error dialog.

Calling for UI will cause your game to enter constrained mode. In constrained mode your title will receive fewer system resources while it is in the background of the UI that has been called for. To learn more about constrained mode and other operational modes for your title read Xbox Game Life Cycle (NDA topic)Authorization required.

Requirements

Header: XGameUI.h

Library: xgameruntime.lib

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

Share via