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

# PFLobbyGetLobbyProperty

> PFLobbyGetLobbyProperty 参考，用于在 PlayFab Multiplayer C++ SDK 中按键从 PlayFab 大厅读取大厅范围的自定义属性值。

根据键获取大厅属性值。

## 语法

```cpp theme={null}
HRESULT PFLobbyGetLobbyProperty(  
    PFLobbyHandle lobby,  
    const char* key,  
    const char** value  
)  
```

### 参数

**`lobby`**   PFLobbyHandle

大厅的句柄。

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

属性的键。

**`value`**   char\*\*\
*library-allocated output, may return nullptr*

与键关联的输出值。输出为 null 值表示该属性不存在。

### 返回值

类型：HRESULT

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

## 备注

大厅属性仅对大厅成员可见。\
\
 如果此大厅对象仍处于通过调用 [PFMultiplayerCreateAndJoinLobby()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayercreateandjoinlobby.md)、[PFMultiplayerCreateAndClaimServerLobby](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayercreateandclaimserverlobby.md)、[PFMultiplayerClaimServerLobby()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerclaimserverlobby.md) 或 [PFMultiplayerJoinLobby()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerjoinlobby.md) 异步创建、加入或领取的过程中，则此方法将不返回任何属性。

## 要求

**头文件：** PFLobby.h

## 另请参阅

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


## Related topics

- [PFMultiplayer C/C++ API 概览 - PFLobby.h](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members.md)
- [PFLobbyGetLobbyPropertyKeys](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetlobbypropertykeys.md)
- [Lobby.GetLobbyProperties](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetLobbyProperties.md)
- [Lobby.GetMemberProperties](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetMemberProperties.md)
- [Lobby.GetSearchProperties](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetSearchProperties.md)