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

# PFMultiplayerJoinArrangedLobby

> 使用来自匹配或其他服务的排列字符串加入 PlayFab 大厅；如果尚无人加入，则根据配置初始化大厅。

使用另一个服务（例如匹配）提供的排列字符串加入大厅。如果尚无人加入该大厅，则使用配置参数对其进行初始化。

## 语法

```cpp theme={null}
HRESULT PFMultiplayerJoinArrangedLobby(  
    PFMultiplayerHandle handle,  
    const PFEntityKey* newMember,  
    const char* arrangementString,  
    const PFLobbyArrangedJoinConfiguration* configuration,  
    void* asyncContext,  
    PFLobbyHandle* lobby  
)  
```

### 参数

**`handle`**   PFMultiplayerHandle

PFMultiplayer API 实例的句柄。

**`newMember`**   [PFEntityKey\*](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/pfentitykey_clientsdk)

加入大厅的本地 PlayFab 实体。

**`arrangementString`**   char\*\
*is null-terminated*

该实体加入大厅所使用的排列字符串。

**`configuration`**   [PFLobbyArrangedJoinConfiguration\*](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyarrangedjoinconfiguration)

在尚无人加入大厅时用于初始化大厅的初始配置数据。

**`asyncContext`**   void\*\
*optional*

一个可选的、应用定义的、指针大小的上下文值，可用于将完成状态更改与此调用相关联。

**`lobby`**   PFLobbyHandle\*\
*optional, library-allocated output*

可选的输出大厅对象，可用于在此操作完成后立即排队执行操作。

### 返回值

类型：HRESULT

如果调用成功，则为 `S_OK`；否则为错误代码。可通过 [PFMultiplayerGetErrorMessage()](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/functions/pfmultiplayergeterrormessage) 检索错误代码的可读形式。

## 备注

这是一个异步操作。成功完成后，将向标题依次提供一个 [PFLobbyMemberAddedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberaddedstatechange) 以及一个 [PFLobbyJoinArrangedLobbyCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinarrangedlobbycompletedstatechange)，其中 [PFLobbyJoinArrangedLobbyCompletedStateChange::result](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinarrangedlobbycompletedstatechange) 字段设置为 `S_OK`。完成失败时，将向标题提供一个 [PFLobbyJoinArrangedLobbyCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinarrangedlobbycompletedstatechange)，其中 [PFLobbyJoinArrangedLobbyCompletedStateChange::result](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinarrangedlobbycompletedstatechange) 字段设置为失败。<br /><br /> 通过此库使用匹配时，可将 [PFMatchmakingMatchDetails::lobbyArrangementString](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingmatchdetails) 与此方法一起使用，以加入包含所有一起匹配的用户的大厅。

## 要求

**头文件：** PFLobby.h

## 另请参阅

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


## Related topics

- [从 MPSD 迁移到 PlayFab Multiplayer 和 MPA](/zh-CN/services/xbox-services/multiplayer/mpsd/concepts/live-mpsd-to-mlp.md)
- [同时使用大厅和匹配](/zh-CN/services/playfab/multiplayer/lobby/lobby-and-matchmaking.md)
- [PFMatchmakingMatchDetails](/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingmatchdetails.md)
- [PFMultiplayer C/C++ API 概览 - PFLobby.h](/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members.md)
- [PFLobbyStateChangeType](/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbystatechangetype.md)
