XblSocialSubscribeToSocialRelationshipChange

Article
06/22/2023

Subscribes to the social service for people changed events. DEPRECATED. Calling this API is no longer required and it will be removed in a future release. RTA subscription will be managed automatically by XSAPI as XblSocialRelationshipChangedHandler are added and removed.

Syntax

HRESULT XblSocialSubscribeToSocialRelationshipChange(  
         XblContextHandle xboxLiveContext,  
         uint64_t xboxUserId,  
         XblRealTimeActivitySubscriptionHandle* subscriptionHandle  
)

Parameters

xboxLiveContext _In_
Type: XblContextHandle

An xbox live context handle created with XblContextCreateHandle.

xboxUserId _In_
Type: uint64_t

The Xbox User ID of the player requesting the subscription.

subscriptionHandle _Out_
Type: XblRealTimeActivitySubscriptionHandle*

Passes back a handle to the subscription which is used to un-subscribe.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

Call XblSocialUnsubscribeFromSocialRelationshipChange to un-subscribe.

Requirements

Header: social_c.h

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

Share via