XblProfileGetUserProfilesForSocialGroupAsync

Gets profiles for users in a specified social group.

Syntax

HRESULT XblProfileGetUserProfilesForSocialGroupAsync(  
         XblContextHandle xboxLiveContext,  
         const char* socialGroup,  
         XAsyncBlock* async  
)  

Parameters

xboxLiveContext   _In_
Type: XblContextHandle

An xbox live context handle created with XblContextCreateHandle.

socialGroup   _In_z_
Type: char*

The UTF-8 encoded name of the social group of users to search. Options are "Favorites" and "People".

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 XblProfileGetUserProfilesForSocialGroupResultCount to get the count of returned profiles and then call XblProfileGetUserProfilesForSocialGroupResult inside the AsyncBlock callback or after the AsyncBlock is complete.

REST Call

Calls V2 GET /users/{userId}/profile/settings/people/{socialGroup}

Requirements

Header: profile_c.h

Library: Microsoft.Xbox.Services.141.GSDK.C.lib

See also

profile_c