XblMultiplayerActivityDeleteActivityAsync

Clears the multiplayer activity for the local user.

Syntax

HRESULT XblMultiplayerActivityDeleteActivityAsync(  
         XblContextHandle xblContext,  
         XAsyncBlock* async  
)  

Parameters

xblContext   _In_
Type: XblContextHandle

Xbox Live context for the local user.

async   _In_
Type: XAsyncBlock*

The XAsyncBlock for this operation.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

Titles should delete the activity for a user as soon as they leave the multiplayer activity.

If the title does not delete a user's activity, it is automatically cleared by a presence check.

To get the result of the asynchronous operation, call XAsyncGetStatus inside the XAsyncBlock callback or after XAsyncBlock is complete.

To see how this function is used, see "Deleting an activity" in the Activities section of Example code for Multiplayer Activity.

For more information about multiplayer activities, see Activities.

REST Call

Calls DELETE /titles/{titleId}/users/{xuid}/activites

Requirements

Header: multiplayer_activity_c.h

Library: Microsoft.Xbox.Services.141.GSDK.C.lib

See also

multiplayer_activity_c