XblMultiplayerGetSearchHandlesAsync

按会话的关联搜索句柄搜索会话。

语法

HRESULT XblMultiplayerGetSearchHandlesAsync(  
         XblContextHandle xblContext,  
         const char* scid,  
         const char* sessionTemplateName,  
         const char* orderByAttribute,  
         bool orderAscending,  
         const char* searchFilter,  
         const char* socialGroup,  
         XAsyncBlock* async  
)  

参数

xblContext _In_
类型:XblContextHandle

本地用户的 Xbox Live 上下文。

scid _In_z_
类型:char*

要在其中查询搜索句柄的服务配置 ID (SCID)。 SCID 被视为区分大小写,因此可以直接从合作伙伴中心粘贴它

sessionTemplateName _In_z_
类型:char*

要查询搜索句柄的模板的名称。

orderByAttribute _In_opt_z_
类型:char*

这将指定用于对搜索句柄排序的属性。 将空字符串传递到默认值,以便按“Timestamp asc”进行排序。

orderAscending _In_
类型:bool

传递 true 将按升序排序,传递 false 将按降序排序。

searchFilter _In_opt_z_
类型:char*

要获取其搜索句柄的查询字符串。

socialGroup _In_opt_z_
类型:char*

要获取其搜索句柄的社交组。

async _In_
类型:XAsyncBlock*

此操作的 AsyncBlock。

返回值

类型:HRESULT

此 API 操作的 HRESULT 返回代码。

备注

筛选搜索句柄: 该查询语法类似 OData,只支持以下运算符:EQ、NE、GE、GT、LE、LT 以及逻辑运算符 AND 和 OR。 示例 1:要过滤某一特定 XboxUserId 的搜索句柄,请使用“MemberXuids/any(d:d eq '12345678')”或“OwnerXuids/any(d:d eq '12345678')”。示例 2:要过滤某一游戏定义的字符串元数据的搜索句柄,请使用“Strings/stringMetadataType eq 'value'”。示例 3:要过滤某一游戏定义的数字元数据和标签类型值的搜索句柄,请使用“Numbers/numberMetadataType eq 53 AND Tags/tagType eq 'value'”空过滤器和社交组:由于 searchFilter 和 socialGroup 是可选的,因此请确保在不需要/不使用它们时,传入了 nullptr。 传入空字符串 "" 将起作用。

要求

头文件:multiplayer_c.h

图书馆: Microsoft.Xbox.Services.14x.GDK.C.lib

另请参阅

multiplayer_c