XblSocialManagerCreateSocialUserGroupFromList

Constructs a social XblSocialManagerUserGroup, which is a collection of users with social information.

Syntax

HRESULT XblSocialManagerCreateSocialUserGroupFromList(  
         XblUserHandle user,  
         uint64_t* xboxUserIdList,  
         size_t xboxUserIdListCount,  
         XblSocialManagerUserGroupHandle* group  
)  

Parameters

user   _In_
Type: XblUserHandle

Xbox Live User.

xboxUserIdList   _In_
Type: uint64_t*

List of users to populate the Xbox Social User Group with. The list cannot exceed XBL_SOCIAL_MANAGER_MAX_USERS_FROM_LIST.

xboxUserIdListCount   _In_
Type: size_t

The number of items in the xboxUserIdList.

group   _Outptr_result_maybenull_
Type: XblSocialManagerUserGroupHandle*

Passes back a handle to the created group. This group may later be cleaned up with XblSocialManagerDestroySocialUserGroup. The group will also be cleaned up (invalidating the returned handle) if the associated user is removed from Social Manager.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

The result of a user group being loaded will be triggered through the XblSocialManagerEventType::SocialUserGroupLoaded event in XblSocialManagerDoWork.

Requirements

Header: social_manager_c.h

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

See also

social_manager_c