XblMultiplayerWriteSessionResult

Gets the result of a XblMultiplayerWriteSessionAsync operation.

Syntax

HRESULT XblMultiplayerWriteSessionResult(  
         XAsyncBlock* async,  
         XblMultiplayerSessionHandle* handle  
)  

Parameters

async   _Inout_
Type: XAsyncBlock*

The AsyncBlock for this operation.

handle   _Out_
Type: XblMultiplayerSessionHandle*

Passes back a handle to a new instance of a local multiplayer session object. The XblMultiplayerSessionHandle must be released by the caller by calling XblMultiplayerSessionCloseHandle. Use XblMultiplayerSession* APIs to get session data from the handle. If the updated session object is not needed, passing nullptr will cause the new multiplayer session object to be cleaned up immediately.

Return value

Type: HRESULT

HRESULT return code for this API operation. It will be a failure HRESULT if there was a network error or failure HTTP status code unless its a 412 (Precondition Failed). A 412 returns success since the service also returns latest session state, so you must call XblMultiplayerSessionWriteStatus() to get the write status and call XblMultiplayerSession* APIs to get session data from the handle.

Remarks

Note that if you leave a session that you are the last member of and the sessionEmptyTimeout is equal to 0, then the session will be deleted immediately. Call XblMultiplayerSessionWriteStatus() to get the write status.

Requirements

Header: multiplayer_c.h

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

See also

multiplayer_c