XblMultiplayerSetSubscriptionsEnabled

Explicitly starts or stops the multiplayer service connectivity via RTA. Enabling the RTA subscription enables: 1. Callbacks when the local Users’s sessions change, using the MultiplayerSession object. Handlers are added with XblMultiplayerAddSessionChangedHandler. 2. Automatic removal of members from sessions when the RTA connection underlying this multiplayer subscription is broken.

Syntax

HRESULT XblMultiplayerSetSubscriptionsEnabled(  
         XblContextHandle xblContext,  
         bool subscriptionsEnabled  
)  

Parameters

xblContext _In_
Type: XblContextHandle XBOX live context for the local user. subscriptionsEnabled _In_
Type: bool True to enable subscriptions and false to stop them.

Return value

Type: HRESULT HRESULT return code for this API operation.

Remarks

This method immediately enables the RTA connection, but the in order to receive session changed callbacks, the session must be written again after enabling sunscriptions.

Requirements

Header: multiplayer_c.h Library: Microsoft.Xbox.Services.142.C.lib or Microsoft.Xbox.Services.143.C.lib

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

Additional pages

Reference

Syntax

Parameters

Return value

Remarks

Requirements

See also

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

Syntax

Parameters

Return value

Remarks

Requirements

See also