Partager via

XGameUiShowAchievementsAsync

  • Article

Displays UI presenting the requesting player's achievements for the specified title.

Syntax

HRESULT XGameUiShowAchievementsAsync(  
         XAsyncBlock* async,  
         XUserHandle requestingUser,  
         uint32_t titleId  
)

Parameters

async   _In_
Type: XAsyncBlock*

A pointer to the XAsyncBlock that is passed to XAsyncRun.

requestingUser   _In_
Type: XUserHandle

The player requesting the list of achievements.

titleId   _In_
Type: uint32_t

The ID of the title that the player is requesting achievements for.

Return value

Type: HRESULT

HRESULT success or error code of the async call.

Remarks

This method does not return a list of achievements, it only displays the achievements in the UI for the player.

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).

Requirements

Header: XGameUI.h

Library: xgameruntime.lib

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

See also

XGameUI
XGameUiShowAchievementsResult
Xbox Game Life Cycle (NDA topic)