XblUserStatisticsGetSingleUserStatisticAsync

Article
06/22/2023

Get a specified statistic for a specified user.

Syntax

HRESULT XblUserStatisticsGetSingleUserStatisticAsync(  
         XblContextHandle xblContextHandle,  
         uint64_t xboxUserId,  
         const char* serviceConfigurationId,  
         const char* statisticName,  
         XAsyncBlock* async  
)

Parameters

xblContextHandle _In_
Type: XblContextHandle

Xbox live context for the local user.

xboxUserId _In_
Type: uint64_t

The Xbox User ID of the player to get statistics for.

serviceConfigurationId _In_z_
Type: char*

The Service Configuration ID (SCID) for the title. The SCID is considered case sensitive so paste it directly from the Partner Center.

statisticName _In_z_
Type: char*

The name of the statistic to return.

async _In_
Type: XAsyncBlock*

The AsyncBlock for this operation.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

Call XblUserStatisticsGetSingleUserStatisticResultSize and XblUserStatisticsGetSingleUserStatisticResult upon completion to get the result.

If using event-based Stats, statistic names will coincide with each stat's stat instance. If using title-managed Stats, statistic names will coincide with each stat's ID.

REST Call

V1 GET /users/xuid({xuid})/scids/{scid}/stats/{statname1}

Requirements

Header: user_statistics_c.h

Library: Microsoft.Xbox.Services.14x.GDK.C.lib

Share via