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//people?view=&startIndex=&maxItems=

Requirements

Header: social_c.h Library: Microsoft.Xbox.Services.14x.GDK.C.lib

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

XblSocialGetSocialRelationshipsAsync

XblSocialGetSocialRelationshipsAsync

Syntax

Parameters

Return value

Remarks

REST Call

Requirements

See also

​XblSocialGetSocialRelationshipsAsync

​Syntax

​Parameters

​Return value

​Remarks

​REST Call

​Requirements

​See also

XblSocialGetSocialRelationshipsAsync

Syntax

Parameters

Return value

Remarks

REST Call

Requirements

See also