PFLobbyGetSearchProperty

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

語法

HRESULT PFLobbyGetSearchProperty(  
    PFLobbyHandle lobby,  
    const char* key,  
    const char** value  
)  

lobby PFLobbyHandle 大廳的控制代碼。 key char*
以 null 結尾 屬性的索引鍵。 value char**
程式庫配置的輸出，可能傳回 nullptr 與索引鍵相關聯的輸出值。輸出 null 值表示該屬性不存在。

類型：HRESULT 如果呼叫成功，則為 S_OK；否則為錯誤碼。可透過 PFMultiplayerGetErrorMessage() 擷取錯誤碼的人類可讀形式。

搜尋屬性會以中繼資料的形式對大廳的非成員顯示，可用於篩選和排序大廳搜尋結果。

如果此大廳物件仍在透過呼叫 PFMultiplayerCreateAndJoinLobby()、PFMultiplayerCreateAndClaimServerLobby、PFMultiplayerClaimServerLobby() 或 PFMultiplayerJoinLobby() 以非同步方式建立、加入或宣告的過程中，此方法將不會傳回任何屬性。

標頭： PFLobby.h