XblMultiplayerDeleteSearchHandleAsync

  • Article

Delete a search handle from the MPSD service.

Syntax

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

Parameters

xblContext   _In_
Type: XblContextHandle

Xbox live context for the local user.

handleId   _In_
Type: char*

Id of the search handle to delete. Obtained from either the search handle or session handle.

async   _In_
Type: XAsyncBlock*

The AsyncBlock for this operation.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

Note that this will not destroy local search handle objects; the lifetime of those objects is still managed by XblMultiplayerSearchHandleCloseHandle. Once the search handle object is deleted from service, the associated session will no longer be searchable.

Requirements

Header: multiplayer_c.h

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

See also

multiplayer_c