PFLobbyLeave
1 人またはすべてのローカル ユーザーにロビーからの退出を要求します。
構文
HRESULT PFLobbyLeave(
PFLobbyHandle lobby,
const PFEntityKey* localUser,
void* asyncContext
)
パラメーター
lobby PFLobbyHandle
ロビーのハンドル。
localUser
PFEntityKey*
省略可能
特定のローカル ユーザーがロビーを離れる必要があるかどうかを示す省略可能な値。 この値が nullptr の場合、すべてのローカル ユーザーがロビーを離れます。
asyncContext void*
オプション
完了状態の変更をこの呼び出しに関連付けるために使用できる、オプションの、アプリによって定義されたポインター サイズのコンテキスト値。
戻り値
型: HRESULT
呼び出しが成功した場合は S_OK、それ以外の場合はエラー コードになります。 人間が読める形式のエラー コードは、PartyManager::GetErrorMessage() を介して取得できます。
解説
このメソッドは、ロビーから 1 人またはすべてのローカル ユーザーを削除する非同期操作をキューに入れます。 完了すると、操作が完了したことを示す PFLobbyLeaveLobbyCompletedStateChange が提供されます。
このメソッドは、退出が成功することを保証するものではありません。 ネットワークまたはサービス エラーが原因で操作が失敗する可能性があります。 休暇試行が失敗したが再トライ可能な場合、ライブラリは引き続き休暇操作を再試行します。 それ以外の場合、ローカル クライアントは要求されたローカル メンバーをロビーから切断しますが、メンバーのままにします。 再参加するまで、切断されたメンバーとして残ります。
このメソッドは、game_server エンティティによって呼び出すことはできません。
要件
ヘッダー: PFLobby.h