XblPresenceGetPresenceForSocialGroupAsync

Gets presence info for a specific group of users.

Syntax

HRESULT XblPresenceGetPresenceForSocialGroupAsync(  
         XblContextHandle xblContextHandle,  
         const char* socialGroupName,  
         uint64_t* socialGroupOwnerXuid,  
         XblPresenceQueryFilters* filters,  
         XAsyncBlock* async  
)  

Parameters

xblContextHandle   _In_
Type: XblContextHandle

Xbox live context for the local user.

socialGroupName   _In_z_
Type: char*

The name of the group of users to get presence for. This can be either "Favorites" to retrieve information about favorites, "People" to retrieve information about mutual friends and people a user follows, or "Friends" to retrieve information about mutual friends.

socialGroupOwnerXuid   _In_opt_
Type: uint64_t*

The user whose group should be targeted. If the input is null, current user will be used.

filters   _In_opt_
Type: XblPresenceQueryFilters*

Optional filters struct to filter results.

async   _In_
Type: XAsyncBlock*

The AsyncBlock for this operation.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

To retrieve the result of calling XblPresenceGetPresenceForSocialGroupAsync, call XblPresenceGetPresenceForSocialGroupResult. To retrieve the required buffer size to hold the results of calling XblPresenceGetPresenceForSocialGroupAsync, call XblPresenceGetPresenceForSocialGroupResultCount.

Requirements

Header: presence_c.h

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

See also

presence_c