> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XblMultiplayerGetSearchHandlesAsync

> XblMultiplayerGetSearchHandlesAsync

# XblMultiplayerGetSearchHandlesAsync

根据关联的搜索句柄搜索会话。

## 语法

```cpp theme={null}
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](/reference/live/xsapi-c/types_c/handles/xblcontexthandle)

本地用户的 XBOX Live 上下文。

*scid*   \_In\_z\_\
类型：char\*

要在其中查询搜索句柄的服务配置 ID (SCID)。SCID 区分大小写，因此请直接从合作伙伴中心 (Partner Center) 粘贴。

*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：要筛选具有标题定义的数字元数据 AND 标签类型值的搜索句柄，请使用 "Numbers/numberMetadataType eq 53 AND Tags/tagType eq 'value'"。**空的筛选器和社交组：** 由于 searchFilter 和 socialGroup 是可选的，如果不需要或不使用它们，请务必传入 nullptr。传入空字符串 "" **无法**正常工作。

## 要求

**头文件：** multiplayer\_c.h

**库：** Microsoft.Xbox.Services.14x.GDK.C.lib

## 另请参阅

[multiplayer\_c](/reference/live/xsapi-c/multiplayer_c/multiplayer_c_members)


## Related topics

- [XblMultiplayerGetSearchHandlesResult](/zh-CN/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsearchhandlesresult.md)
- [XblMultiplayerGetSearchHandlesResultCount](/zh-CN/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsearchhandlesresultcount.md)
- [从 MPSD 迁移到 PlayFab Multiplayer 和 MPA](/zh-CN/services/xbox-services/multiplayer/mpsd/concepts/live-mpsd-to-mlp.md)
- [XblMultiplayerCreateSearchHandleAsync](/zh-CN/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayercreatesearchhandleasync.md)
- [XblMultiplayerDeleteSearchHandleAsync](/zh-CN/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerdeletesearchhandleasync.md)