Partager via


XblSocialManagerUserGroupGetUsers

Gets an XblSocialManagerUserPtrArray of the users tracked by the user group.

Syntax

HRESULT XblSocialManagerUserGroupGetUsers(  
         XblSocialManagerUserGroupHandle group,  
         XblSocialManagerUserPtrArray* users,  
         size_t* usersCount  
)  

Parameters

group   _In_
Type: XblSocialManagerUserGroupHandle

The group handle from which to get users.

users   _Outptr_result_maybenull_
Type: XblSocialManagerUserPtrArray*

Passes back a pointer to an array of XblSocialManagerUser objects. The memory for the returned pointer remains valid until the next time XblSocialManagerDoWork is called.

usersCount   _Out_
Type: size_t*

Passes back the size of the users array.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

The XblSocialManagerUserPtrArray is only guaranteed to be valid until the next call to XblSocialManagerDoWork. If the user objects are needed beyond the scope of the next XblSocialManagerDoWork call, they are statically sized and trivially copyable. Call this API after calling either XblSocialManagerCreateSocialUserGroupFromFilters or XblSocialManagerCreateSocialUserGroupFromList to create an XblSocialManagerUserGroup. Have the XblSocialManagerUserGroupHandle returned by 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