XblSocialGetSocialRelationshipsAsync

Gets a list of people that the caller is socially connected to.

Syntax

HRESULT XblSocialGetSocialRelationshipsAsync(  
         XblContextHandle xboxLiveContext,  
         uint64_t xboxUserId,  
         XblSocialRelationshipFilter socialRelationshipFilter,  
         size_t startIndex,  
         size_t maxItems,  
         XAsyncBlock* async  
)  

Parameters

xboxLiveContext   _In_
Type: XblContextHandle

An xbox live context handle created with XblContextCreateHandle.

xboxUserId   _In_
Type: uint64_t

The Xbox User Id to get the social relationships for.

socialRelationshipFilter   _In_
Type: XblSocialRelationshipFilter

Controls how the list is filtered.

startIndex   _In_
Type: size_t

Controls the starting index of the results list.

maxItems   _In_
Type: size_t

The maximum number of items that the results list can contain. Pass 0 to attempt to retrieve all items.

async   _In_
Type: XAsyncBlock*

Caller allocated XAsyncBlock.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

Call XblSocialGetSocialRelationshipsResult to get the result.

REST Call

V1 GET /users/{ownerId}/people?view={view}&startIndex={startIndex}&maxItems={maxItems}

Requirements

Header: social_c.h

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

See also

social_c