PFLobbyGetSearchProperty
キーから検索プロパティの値を取得します。
構文
HRESULT PFLobbyGetSearchProperty(
PFLobbyHandle lobby,
const char* key,
const char** value
)
パラメーター
lobby
PFLobbyHandle
ロビーのハンドル。
key
char*
が null で終わる
プロパティのキー。
value
char**
ライブラリに割り当てられた出力、nullptr を返す場合があります
キーに関連付けられている出力値。 出力 null 値は、プロパティが存在しなかったことを示します。
戻り値
型: HRESULT
呼び出しが成功した場合は S_OK
、それ以外の場合はエラー コードになります。 人間が読める形式のエラー コードは、PartyManager::GetErrorMessage() を介して取得できます。
解説
検索プロパティは、ロビーの検索結果のフィルター処理と並べ替えに使用できるメタデータとしてロビーのメンバー以外に表示されます。
このロビー オブジェクトが、PFMultiplayerCreateAndJoinLobby()、PFMultiplayerCreateAndClaimServerLobby、PFMultiplayerClaimServerLobby() または PFMultiplayerJoinLobby() の呼び出しを介して非同期に作成、結合、または要求される処理中の場合、このメソッドはプロパティを返しません。
要件
ヘッダー: PFLobby.h