XblMultiplayerGetSessionByHandleAsync

Gets a session object with all its attributes from the server, given a session handle id.

Syntax

HRESULT XblMultiplayerGetSessionByHandleAsync(  
         XblContextHandle xblContext,  
         const char* handleId,  
         XAsyncBlock* async  
)  

Parameters

xblContext   _In_
Type: XblContextHandle XBOX live context for the local user. handleId   _In_
Type: char* A multiplayer handle id, which uniquely identifies the session. async   _In_
Type: XAsyncBlock* The AsyncBlock for this operation.

Return value

Type: HRESULT HRESULT return code for this API operation.

Remarks

A handle is a service-side pointer to a session. The handleId is a GUID identifier of the handle. Callers will usually get the handleId either from another player’s XblMultiplayerActivityDetails, or from an invite.

REST Call

Calls GET /handles/{handleId}/session

Requirements

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

Conceptual documentation

Receiving invites

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

REST Call

Requirements

Conceptual documentation

See also

​Syntax

​Parameters

​Return value

​Remarks

​REST Call

​Requirements

​Conceptual documentation

​See also

Syntax

Parameters

Return value

Remarks

REST Call

Requirements

Conceptual documentation

See also