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

# PFLobbyGetSearchProperty

> 使用 PlayFab Multiplayer C++ SDK 大廳 API 依索引鍵讀取 PlayFab 大廳上可搜尋屬性值的 PFLobbyGetSearchProperty 參考。

從索引鍵取得搜尋屬性值。

## 語法

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

### 參數

**`lobby`**   PFLobbyHandle

大廳的控制代碼。

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

屬性的索引鍵。

**`value`**   char\*\*\
*程式庫配置的輸出，可能傳回 nullptr*

與索引鍵相關聯的輸出值。輸出 null 值表示該屬性不存在。

### 傳回值

類型：HRESULT

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

## 備註

搜尋屬性會以中繼資料的形式對大廳的非成員顯示，可用於篩選和排序大廳搜尋結果。 <br /><br /> 如果此大廳物件仍在透過呼叫 [PFMultiplayerCreateAndJoinLobby()](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayercreateandjoinlobby)、[PFMultiplayerCreateAndClaimServerLobby](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayercreateandclaimserverlobby)、[PFMultiplayerClaimServerLobby()](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerclaimserverlobby) 或 [PFMultiplayerJoinLobby()](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerjoinlobby) 以非同步方式建立、加入或宣告的過程中，此方法將不會傳回任何屬性。

## 需求

**標頭：** PFLobby.h

## 另請參閱

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


## Related topics

- [PFLobbyGetSearchPropertyKeys](/zh-TW/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetsearchpropertykeys.md)
- [Lobby.GetSearchProperties](/zh-TW/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/GetSearchProperties.md)
- [LobbySearchResult.SearchProperties](/zh-TW/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbySearchResult/SearchProperties.md)
- [Lobby.LobbyMaxSearchPropertyCount](/zh-TW/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyConstants/LobbyMaxSearchPropertyCount.md)
- [LobbyDataUpdate.SearchProperties](/zh-TW/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyDataUpdate/SearchProperties.md)