XblRealTimeActivityAddConnectionStateChangeHandler

Registers a handler function to receive a notification that is sent when the client service loses or gains connectivity to the Real-Time Activity (RTA) service.

Syntax

XblFunctionContext XblRealTimeActivityAddConnectionStateChangeHandler(  
         XblContextHandle xboxLiveContext,  
         XblRealTimeActivityConnectionStateChangeHandler* handler,  
         void* context  
)  

Parameters

xboxLiveContext   _In_
Type: XblContextHandle XBOX services context handle. handler   _In_
Type: XblRealTimeActivityConnectionStateChangeHandler* The callback function that receives notifications. context   _In_opt_
Type: void* Caller context that will be passed back to the handler function.

Return value

Type: XblFunctionContext An XblFunctionContext object that can be used to unregister the event handler. Pass it to XblRealTimeActivityRemoveConnectionStateChangeHandler. A successful registration returns a token greater than 0. If the function fails, it can return an HRESULT error code cast to XblFunctionContext, which is a negative value. Possible error codes include the following. This list isn’t exhaustive.

Return code	Description
E_INVALIDARG	xboxLiveContext or handler is null.
E_XBL_NOT_INITIALIZED	The XBOX services API (XSAPI) isn’t initialized. Call XblInitialize first.

Remarks

The handler is registered for the user that’s associated with xboxLiveContext. XSAPI also calls the handler with XblRealTimeActivityConnectionState::Disconnected when it closes an idle connection because the user has no remaining RTA subscriptions or legacy activations. XSAPI catches and logs exceptions that the handler throws.

Requirements

Header: real_time_activity_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