PFMultiplayerClaimServerLobby
既存のサーバー ロビーの所有権を要求します。
構文
HRESULT PFMultiplayerClaimServerLobby(
PFMultiplayerHandle handle,
const PFEntityKey* server,
const char* lobbyId,
void* asyncContext,
PFLobbyHandle* lobby
)
パラメーター
handle
PFMultiplayerHandle
PFMultiplayer API インスタンスのハンドル。
server
PFEntityKey*
ロビーを要求するゲーム サーバーの PlayFab エンティティ キー。 エンティティ型は "game_server" である必要があります。
lobbyId
char*
が null で終わる
要求するロビーの ID。
asyncContext
void*
オプション
完了状態の変更をこの呼び出しに関連付けるために使用できる、オプションの、アプリによって定義されたポインター サイズのコンテキスト値。
lobby
PFLobbyHandle*
オプションで割り当てられたライブラリの出力
この操作を即時に実行するためにキュー操作に使用できるオプションの出力ロビー オブジェクトが完了します。
戻り値
型: HRESULT
呼び出しが成功した場合は S_OK
、それ以外の場合はエラー コードになります。 人間が読める形式のエラー コードは、PartyManager::GetErrorMessage() を介して取得できます。
解説
この機能を使用するには、PFLobby.h を含める前にPFMULTIPLAYER_INCLUDE_SERVER_APIS を定義する必要があります。
これは非同期操作です。 正常に完了すると、タイトルには PFLobbyClaimServerLobbyCompletedStateChange が提供され、 PFLobbyClaimServerLobbyCompletedStateChange::result フィールドが S_OK
に設定されます。 完了に失敗すると、タイトルには PFLobbyClaimServerLobbyCompletedStateChange が提供され、 PFLobbyClaimServerLobbyCompletedStateChange::result フィールドが失敗に設定されます。
この操作は主に、切断された、あるいはこれから切断されるサーバーが所有するロビーの所有権を game_server エンティティが取得することをサポートすることを目的としています。 通常、これは所有権を別の game_server エンティティに移行したい game_server エンティティや、クラッシュなどのロビー ハンドルへのアクセスを失う致命的な障害が発生した後に自分のサーバーの所有権を回復する必要がある game_server エンティティにとって興味深いものです。
ゲーム サーバーは、別の game_server エンティティが現在接続されているロビーの所有権を要求することはできません。
要件
ヘッダー: PFLobby.h