> ## 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.

# PFLobbySearchConfiguration

> PFMultiplayerFindLobbies 的配置结构体：为大厅搜索指定好友筛选器、筛选字符串、排序字符串和客户端搜索结果数。

用于指定应如何执行 [PFMultiplayerFindLobbies](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfindlobbies) 操作的配置结构。

## 语法

```cpp theme={null}
struct PFLobbySearchConfiguration {  
    const PFLobbySearchFriendsFilter* friendsFilter;  
    const char* filterString;  
    const char* sortString;  
    const uint32_t* clientSearchResultCount;  
}  
```

### 成员

**`friendsFilter`**   const [PFLobbySearchFriendsFilter](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbysearchfriendsfilter)\*\
*may be nullptr*

一个筛选器，当提供时，将把大厅搜索操作约束为仅搜索由该玩家各个好友列表的成员所拥有的大厅。

如果省略，搜索操作将搜索所有可用的大厅。<br /><br /> 仅当使用 title\_player\_account 实体调用 [PFMultiplayerFindLobbies](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfindlobbies) 时，才能指定此值。

**`filterString`**   const char\*\
*is null-terminated*

用于筛选在搜索结果中返回哪些大厅的查询字符串。

此字符串采用类似 OData 的筛选语法。<br /><br /> 仅支持以下运算符："and"（逻辑与）、"eq"（等于）、"ne"（不等于）、"ge"（大于或等于）、"gt"（大于）、"le"（小于或等于）和 "lt"（小于）。<br /><br /> 每个 OData 逻辑表达式的左侧应为搜索属性键（例如 string\_key1、number\_key3 等）或预定义的搜索键之一（`PFLobbyMemberCountSearchKey`、`PFLobbyAmMemberSearchKey` 或 `PFLobbyMembershipLockSearchKey`）<br /><br /> 每个 OData 逻辑表达式的左侧应为搜索属性键。<br /><br /> 此字符串不能超过 500 个字符。<br /><br /> 示例："lobby/membershipLock eq 'Unlocked' and string\_key1 eq 'CaptureTheFlag' and number\_key10 gt 50 and lobby/memberCount lt 5"

**`sortString`**   const char\*\
*is null-terminated*

用于对搜索结果中返回的大厅进行排序的查询字符串。

此字符串采用类似 OData 的 order-by 语法：以逗号分隔的搜索属性键列表，以及一个可选的升序或降序说明符。<br /><br /> 若要指定升序，请在关联的搜索属性键后使用 "asc" 运算符。若要指定降序，请在关联的搜索属性键后使用 "desc" 运算符。<br /><br /> 此外，还支持一个特殊的排序标识符 distance，用于按与某个数字值的最近距离进行排序。例如，"distance\{number\_key10=5} asc" 将对结果进行排序，使其 "number\_key10" 搜索属性更接近值 "5" 的大厅在搜索结果中更早返回。<br /><br /> 此字符串不能超过 100 个字符。<br /><br /> 示例："string\_key1 asc,lobby/memberCount desc"

**`clientSearchResultCount`**   const uint32\_t\*\
*may be nullptr*

一个可选值，当由 title\_player\_account 实体指定时，将限制完成响应中提供的结果数量。

仅当使用 title\_player\_account 实体调用 [PFMultiplayerFindLobbies](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfindlobbies) 时，才能指定此值。<br /><br /> 此值不能高于 `PFLobbyClientRequestedSearchResultCountUpperLimit`。<br /><br /> 未指定时，搜索结果数量的限制由服务定义，但不会超过 `PFLobbyClientRequestedSearchResultCountUpperLimit`。

## 要求

**头文件：** PFLobby.h

## 另请参阅

[PFLobby 成员](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members)


## Related topics

- [PFLobby 搜索键](/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/constants/pflobbysearchkeys.md)
- [PFMultiplayerFindLobbies](/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfindlobbies.md)
- [PlayFab Multiplayer C++ SDK 发行说明](/zh-CN/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/lobby-and-matchmaking-release-notes.md)
- [PFMultiplayer C/C++ API 概览 - PFLobby.h](/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members.md)
- [LobbySearchConfiguration](/zh-CN/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchConfiguration/LobbySearchConfiguration.md)