Share via

XGameUiShowPlayerProfileCardAsync

  • Article

Displays UI for the profile card of the specified player.

Syntax

HRESULT XGameUiShowPlayerProfileCardAsync(  
         XAsyncBlock* async,  
         XUserHandle requestingUser,  
         uint64_t targetPlayer  
)

Parameters

async   _In_
Type: XAsyncBlock*

A pointer to the XAsyncBlock that is passed to XAsyncRun.

requestingUser   _In_
Type: XUserHandle

The ID of the player requesting the profile card.

targetPlayer   _In_
Type: uint64_t

The ID of the player to show the profile card for.

Return value

Type: HRESULT

HRESULT success or error code of the async call.

Remarks

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
XGameUIShowPlayerProfileCardResult
Xbox Game Life Cycle (NDA topic)