XblMultiplayerCreateSearchHandleAsync

Create a search handle associated with an existing session. This makes the session queryable.

Syntax

HRESULT XblMultiplayerCreateSearchHandleAsync(  
         XblContextHandle xblContext,  
         const XblMultiplayerSessionReference* sessionRef,  
         const XblMultiplayerSessionTag* tags,  
         size_t tagsCount,  
         const XblMultiplayerSessionNumberAttribute* numberAttributes,  
         size_t numberAttributesCount,  
         const XblMultiplayerSessionStringAttribute* stringAttributes,  
         size_t stringAttributesCount,  
         XAsyncBlock* async  
)  

Parameters

xblContext   _In_
Type: XblContextHandle

Xbox live context for the local user.

sessionRef   _In_
Type: XblMultiplayerSessionReference*

Session reference to create a search handle for.

tags   _In_reads_opt_(tagsCount)
Type: XblMultiplayerSessionTag*

Optional set of tags to attach to search handle.

tagsCount   _In_
Type: size_t

Count of tags.

numberAttributes   _In_reads_opt_(numberAttributesCount)
Type: XblMultiplayerSessionNumberAttribute*

Optional attributes to attach to search handle.

numberAttributesCount   _In_
Type: size_t

Count of number attributes.

stringAttributes   _In_reads_opt_(stringAttributesCount)
Type: XblMultiplayerSessionStringAttribute*

Optional attributes to attach to search handle.

stringAttributesCount   _In_
Type: size_t

Count of string attributes.

async   _In_
Type: XAsyncBlock*

The AsyncBlock for this operation.

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