Share via

XblMultiplayerSessionJoin

  • Article

Joins the local user to the session, sets the user to active.

Syntax

HRESULT XblMultiplayerSessionJoin(  
         XblMultiplayerSessionHandle handle,  
         const char* memberCustomConstantsJson,  
         bool initializeRequested,  
         bool joinWithActiveStatus  
)

Parameters

handle   _In_
Type: XblMultiplayerSessionHandle

Handle to the multiplayer session.

memberCustomConstantsJson   _In_opt_z_
Type: char*

The custom constants to set for this member. This is the only time the member's constants can be set.

initializeRequested   _In_
Type: bool

True if the system should perform managed initialization, and false otherwise.

joinWithActiveStatus   _In_
Type: bool

True if player should join with active status.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Requirements

Header: multiplayer_c.h

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

See also

multiplayer_c