XblMultiplayerWriteSessionByHandleAsync

Writes a new or updated multiplayer session to the service, using the specified handle to the session.

Syntax

HRESULT XblMultiplayerWriteSessionByHandleAsync(  
         XblContextHandle xblContext,  
         XblMultiplayerSessionHandle multiplayerSession,  
         XblMultiplayerSessionWriteMode writeMode,  
         const char* handleId,  
         XAsyncBlock* async  
)  

Parameters

xblContext   _In_
Type: XblContextHandle

Xbox live context for the local user.

multiplayerSession   _In_
Type: XblMultiplayerSessionHandle

A MultiplayerSession object that has been modified with the changes to write.

writeMode   _In_
Type: XblMultiplayerSessionWriteMode

The type of write operation.

handleId   _In_
Type: char*

The ID of the handle that should be used when writing 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 handle ID is a GUID identifier of the handle. Callers will usually get the handleId either from another player's XblMultiplayerActivityDetails via the XblMultiplayerGetActivitiesForUsersAsync() API, or from an invite. Use this method only if your multiplayer session object doesn't have a valid XblMultiplayerSessionReference, as a handle's lifetime may be shorter than that of the session it points to.

Requirements

Header: multiplayer_c.h

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

See also

multiplayer_c