XblProfileGetUserProfilesAsync

Article
06/22/2023

Gets one or more user profiles for a collection of specified Xbox users.

Syntax

HRESULT XblProfileGetUserProfilesAsync(  
         XblContextHandle xboxLiveContext,  
         uint64_t* xboxUserIds,  
         size_t xboxUserIdsCount,  
         XAsyncBlock* async  
)

Parameters

xboxLiveContext _In_
Type: XblContextHandle

An xbox live context handle created with XblContextCreateHandle.

xboxUserIds _In_
Type: uint64_t*

C-style array of Xbox User IDs of the users to get profiles for.

xboxUserIdsCount _In_
Type: size_t

The number of Xbox User IDs in the array.

async _In_
Type: XAsyncBlock*

Caller allocated AsyncBlock.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

To get the result, first call XblProfileGetUserProfilesResultCount to get the count of returned profiles and then call XblProfileGetUserProfilesResult inside the AsyncBlock callback or after the AsyncBlock is complete.

REST Call

Calls V2 GET /users/batch/profile/settings

Requirements

Header: profile_c.h

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

Share via