構文
パラメーター
handle PFMultiplayerHandle
PFMultiplayer API インスタンスのハンドル。
server PFEntityKey*
ロビーを要求するゲーム サーバーの PlayFab エンティティ キー。エンティティ タイプは “game_server” である必要があります。
lobbyId char*null 終端 要求対象のロビー ID。
asyncContext void*省略可能 完了状態の変化をこの呼び出しに関連付けるために使用できる、アプリ定義のポインター サイズのコンテキスト値 (省略可能)。
lobby PFLobbyHandle*省略可能、ライブラリが割り当てる出力 この操作の完了に対して即時に実行する操作をキューに登録するために使用できる、省略可能なロビー オブジェクトの出力。
戻り値
型: HRESULT 呼び出しが成功した場合はS_OK、それ以外の場合はエラー コード。エラー コードの人間が判読可能な形式は、PFMultiplayerGetErrorMessage() を通じて取得できます。
解説
この機能を使用するには、PFLobby.h をインクルードする前に PFMULTIPLAYER_INCLUDE_SERVER_APIS を定義する必要があります。これは非同期操作です。正常に完了すると、タイトルには PFLobbyClaimServerLobbyCompletedStateChange::result フィールドが
S_OK に設定された PFLobbyClaimServerLobbyCompletedStateChange が提供されます。失敗して完了した場合、タイトルには PFLobbyClaimServerLobbyCompletedStateChange::result フィールドが失敗に設定された PFLobbyClaimServerLobbyCompletedStateChange が提供されます。この操作は主に、所有者が切断されている、または切断予定であるサーバー所有ロビーを game_server エンティティが取り込む用途を想定しています。通常、これは所有権を別の game_server エンティティに移行したい game_server エンティティや、クラッシュなどの致命的な障害によりロビー ハンドルへのアクセスを失ったサーバーの所有権を回復する必要のある game_server エンティティで有用です。
ゲーム サーバーは、他の game_server エンティティが現在接続しているロビーの所有権を要求することはできません。