Skip to main content

XUserGetGamerPictureAsync

Asynchronously retrieves the gamer picture for a specific user.

Syntax

Parameters

user   _In_
Type: XUserHandle
The user to retrieve the gamer picture for. pictureSize   _In_
Type: XUserGamerPictureSize
The size of the gamer picture to retrieve. async   _Inout_
Type: XAsyncBlock*
An XAsyncBlock for polling the call’s status and retrieving call results.

Return value

Type: HRESULT HRESULT success or error code.
For a list of error codes, see Error Codes.

Remarks

The “Display Name and Gamerpic” XR lists specific requirements for how user names and avatar images are displayed. Consult XBOX Requirements for XBOX One Games and Hub Apps (XBOX Developer Downloads->Partner, Publishing, and Release Management Information->XGD Partner Documentation) for details. To retrieve the result of a call to XUserGetGamerPictureAsync, call XUserGetGamerPictureResult. To retrieve the buffer size required by XUserGetGamerPictureResult to retrieve the gamer picture returned by XUserGetGamerPictureAsync, call XUserGetGamerPictureResultSize. The format of the returned gamer picture is a .PNG formatted image. The size of the picture could be up to 2^32 bytes. The following example demonstrates how to load a gamer picture.

Requirements

Header: XUser.h Library: xgameruntime.lib Supported platforms: Windows, Steam Deck, XBOX One family consoles and XBOX Series consoles

Conceptual documentation

See also

XUser XUserGetGamerPictureResult XUserGetGamerPictureResultSize
Last modified on October 19, 2026