> ## Documentation Index
> Fetch the complete documentation index at: https://docs.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\*](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/pfentitykey_clientsdk.md)

加入大廳的本機 PlayFab 實體。

**`arrangementString`**   char\*\
*以 null 結尾*

實體用於加入大廳的安排字串。

**`configuration`**   [PFLobbyArrangedJoinConfiguration\*](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyarrangedjoinconfiguration.md)

如果尚無人加入大廳，用於初始化大廳的初始設定資料。

**`asyncContext`**   void\*\
*選用*

選用的應用程式定義指標大小內容值，可用來將完成狀態變更與此呼叫建立關聯。

**`lobby`**   PFLobbyHandle\*\
*選用，程式庫配置的輸出*

選用的輸出大廳物件，可用於將作業排入佇列，以便在此作業完成時立即執行。

### 傳回值

類型：HRESULT

如果呼叫成功，則為 `S_OK`；否則為錯誤碼。可透過 [PFMultiplayerGetErrorMessage()](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/functions/pfmultiplayergeterrormessage.md) 擷取錯誤碼的人類可讀形式。

## 備註

這是一項非同步作業。成功完成時，遊戲會收到 [PFLobbyMemberAddedStateChange](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberaddedstatechange.md)，接著收到 [PFLobbyJoinArrangedLobbyCompletedStateChange::result](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinarrangedlobbycompletedstatechange.md) 欄位設定為 `S_OK` 的 [PFLobbyJoinArrangedLobbyCompletedStateChange](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinarrangedlobbycompletedstatechange.md)。 失敗完成時，遊戲會收到 [PFLobbyJoinArrangedLobbyCompletedStateChange::result](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinarrangedlobbycompletedstatechange.md) 欄位設定為失敗的 [PFLobbyJoinArrangedLobbyCompletedStateChange](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinarrangedlobbycompletedstatechange.md)。 \
\
 透過此程式庫使用配對時，可以將 [PFMatchmakingMatchDetails::lobbyArrangementString](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingmatchdetails.md) 與此方法搭配使用，與所有已配對在一起的使用者加入同一個大廳。

## 需求

**標頭：** PFLobby.h

## 另請參閱

[PFLobby 成員](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members.md)


## Related topics

- [從 MPSD 移至 PlayFab Multiplayer 與 MPA](https://docs.xbox.com/zh-TW/services/xbox-services/multiplayer/mpsd/concepts/live-mpsd-to-mlp.md)
- [搭配使用大廳和配對](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/lobby-and-matchmaking.md)
- [PFMatchmakingMatchDetails](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmatchmaking/structs/pfmatchmakingmatchdetails.md)
- [PFMultiplayer C/C++ API 概觀 - PFLobby.h](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members.md)
- [PFLobbyStateChangeType](https://docs.xbox.com/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbystatechangetype.md)