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

# PFLobbyLeave

> PFLobbyLeave 参考，用于通过异步的 PlayFab Multiplayer C++ SDK 大厅 API 请求某一位或所有本地用户离开 PlayFab 大厅。

请求一位或所有本地用户离开大厅。

## 语法

```cpp theme={null}
HRESULT PFLobbyLeave(  
    PFLobbyHandle lobby,  
    const PFEntityKey* localUser,  
    void* asyncContext  
)  
```

### 参数

**`lobby`**   PFLobbyHandle

大厅的句柄。

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

一个可选值，用于指示是否应有特定本地用户离开大厅。如果此值为 nullptr，则所有本地用户都将离开大厅。

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

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

### 返回值

类型：HRESULT

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

## 备注

此方法会将一个异步操作排队，用于将一位或所有本地用户从大厅中移除。完成后，将提供一个 [PFLobbyLeaveLobbyCompletedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyleavelobbycompletedstatechange.md) 以指示操作已完成。\
\
 此方法不保证离开操作会成功。该操作可能因网络或服务错误而失败。如果离开尝试失败但可重试，则库将继续重试离开操作。否则，本地客户端将断开所请求本地成员与大厅的连接，但仍将其保留为成员。他们将保持为已断开连接的成员，直到重新加入。  \
\
 此方法不能由 game\_server 实体调用。

## 要求

**头文件：** PFLobby.h

## 另请参阅

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


## Related topics

- [PFLobbyMemberRemovedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberremovedstatechange.md)
- [PFLobbyMemberRemovedReason](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbymemberremovedreason.md)
- [PFMultiplayerUninitialize](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/functions/pfmultiplayeruninitialize.md)
- [同时使用大厅和匹配](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/lobby-and-matchmaking.md)
- [PFLobbyStateChangeType](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbystatechangetype.md)