> ## 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](/zh-TW/reference/live/xsapi-c/types_c/handles/xblcontexthandle)

本機使用者的 XBOX Live 內容。

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

要在其中查詢搜尋控制代碼的服務設定識別碼 (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：若要篩選遊戲定義之數字中繼資料「且」具有標籤類型值的搜尋控制代碼，請使用 "Numbers/numberMetadataType eq 53 AND Tags/tagType eq 'value'"。**空白篩選條件和社交群組：** 由於 searchFilter 和 socialGroup 是選擇性的，如果不需要或未使用，請務必傳入 nullptr。傳入空字串 "" 將**無法**運作。

## 需求

**標頭：** multiplayer\_c.h

**程式庫：** Microsoft.Xbox.Services.14x.GDK.C.lib

## 另請參閱

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


## Related topics

- [XblMultiplayerGetSearchHandlesResult](/zh-TW/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsearchhandlesresult.md)
- [XblMultiplayerGetSearchHandlesResultCount](/zh-TW/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayergetsearchhandlesresultcount.md)
- [從 MPSD 移至 PlayFab Multiplayer 與 MPA](/zh-TW/services/xbox-services/multiplayer/mpsd/concepts/live-mpsd-to-mlp.md)
- [XblMultiplayerCreateSearchHandleAsync](/zh-TW/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayercreatesearchhandleasync.md)
- [XblMultiplayerDeleteSearchHandleAsync](/zh-TW/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayerdeletesearchhandleasync.md)