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

# PFLobbyLeave

> 使用非同步 PlayFab Multiplayer C++ SDK 大廳 API 要求一個或所有本機使用者離開 PlayFab 大廳的 PFLobbyLeave 參考。

要求一個或所有本機使用者離開大廳。

## 語法

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

### 參數

**`lobby`**   PFLobbyHandle

大廳的控制代碼。

**`localUser`**   [PFEntityKey\*](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/pfentitykey_clientsdk)\
*選用*

選用值，表示是否應由特定的本機使用者離開大廳。如果此值為 nullptr，所有本機使用者都會離開大廳。

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

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

### 傳回值

類型：HRESULT

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

## 備註

此方法會將非同步作業排入佇列，以從大廳中移除一個或所有本機使用者。完成時，會提供 [PFLobbyLeaveLobbyCompletedStateChange](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyleavelobbycompletedstatechange) 表示作業已完成。 <br /><br /> 此方法不保證離開會成功。作業可能會因網路或服務錯誤而失敗。如果離開嘗試失敗但可以重試，程式庫會繼續重試離開作業。否則，本機用戶端會將要求的本機成員與大廳中斷連線，但保留他們的成員身分。在重新加入之前，他們會維持為已中斷連線的成員。   <br /><br /> 此方法不能由 game\_server 實體呼叫。

## 需求

**標頭：** PFLobby.h

## 另請參閱

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


## Related topics

- [PFLobbyMemberRemovedStateChange](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberremovedstatechange.md)
- [PFLobbyMemberRemovedReason](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbymemberremovedreason.md)
- [PFMultiplayerUninitialize](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/functions/pfmultiplayeruninitialize.md)
- [搭配使用大廳和配對](/zh-TW/services/playfab/multiplayer/lobby/lobby-and-matchmaking.md)
- [PFLobbyStateChangeType](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbystatechangetype.md)