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

# PFMultiplayerConnectToLobby

> PFMultiplayerConnectToLobby 参考，用于通过 PlayFab Multiplayer C++ SDK 将本地 PlayFab 实体连接到之前已被添加至的大厅。

连接到本地 PlayFab 实体已经作为成员被添加进去的大厅。

## 语法

```cpp theme={null}
HRESULT PFMultiplayerConnectToLobby(  
    PFMultiplayerHandle handle,  
    const PFEntityKey* newMember,  
    const char* lobbyId,  
    void* asyncContext,  
    PFLobbyHandle* lobby  
)  
```

### 参数

**`handle`**   PFMultiplayerHandle

PFMultiplayer API 实例的句柄。

**`newMember`**   [PFEntityKey\*](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/pfentitykey_clientsdk.md)

连接到大厅的本地实体。

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

要连接的大厅的 ID。

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

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

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

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

### 返回值

类型：HRESULT

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

## 备注

这是一个异步操作。成功完成后，将向标题依次提供一个 [PFLobbyMemberAddedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberaddedstatechange.md)、一个 [PFLobbyUpdatedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyupdatedstatechange.md) 以及一个 [PFLobbyConnectToLobbyCompletedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyconnecttolobbycompletedstatechange.md)，其中 [PFLobbyConnectToLobbyCompletedStateChange::result](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyconnecttolobbycompletedstatechange.md) 字段设置为 `S_OK`。完成失败时，将向标题提供一个 [PFLobbyConnectToLobbyCompletedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyconnecttolobbycompletedstatechange.md)，其中 [PFLobbyConnectToLobbyCompletedStateChange::result](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyconnecttolobbycompletedstatechange.md) 字段设置为失败。

## 要求

**头文件：** PFLobby.h

## 另请参阅

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


## Related topics

- [PlayFab Multiplayer C++ SDK 发行说明](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/lobby-and-matchmaking-release-notes.md)
- [PFMultiplayer C/C++ API 概览 - PFLobby.h](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members.md)
- [PFLobbyStateChangeType](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbystatechangetype.md)
- [PFLobbyConnectToLobbyCompletedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyconnecttolobbycompletedstatechange.md)
- [Lobby.ConnectionString](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/ConnectionString.md)
