PFLobbyForceRemoveMember
ロビーからエンティティを強制的に削除します。
構文
HRESULT PFLobbyForceRemoveMember(
PFLobbyHandle lobby,
const PFEntityKey* targetMember,
bool preventRejoin,
void* asyncContext
)
パラメーター
lobby
PFLobbyHandle
ロビーのハンドル。
targetMember
PFEntityKey*
強制的に削除するメンバー。
preventRejoin
bool
targetMember
が削除された後にロビーに再び参加できないようにするかどうかを示すフラグ。
asyncContext
void*
オプション
完了状態の変更をこの呼び出しに関連付けるために使用できる、オプションの、アプリによって定義されたポインター サイズのコンテキスト値。
戻り値
型: HRESULT
呼び出しが成功した場合は S_OK
、それ以外の場合はエラー コードになります。 人間が読める形式のエラー コードは、PartyManager::GetErrorMessage() を介して取得できます。
解説
これは非同期操作です。 正常に完了すると、タイトルに PFLobbyMemberRemovedStateChange が指定され、その後に PFLobbyForceRemoveMemberCompletedStateChange::result フィールドが S_OK
に設定された PFLobbyForceRemoveMemberCompletedStateChange が設定されます。 完了が失敗すると、タイトルには PFLobbyForceRemoveMemberCompletedStateChange が提供され、 PFLobbyForceRemoveMemberCompletedStateChange::result フィールドが失敗 hresult に設定されます。
このロビーに存在するローカル PlayFab エンティティの 1 つが、この操作を成功させるために所有者である必要があります。 この操作を開始したローカル所有エンティティが操作の進行中に所有権の状態を失うと、操作は非同期的に失敗します。
これは非同期操作です。 このメソッドを使用して削除されたメンバーは、非同期操作が正常に完了し、PFMultiplayerStartProcessingLobbyStateChanges によって PFLobbyMemberRemovedStateChange
構造体が指定されるまで、PFLobbyGetMembers が返すリストから削除されません。
要件
ヘッダー: PFLobby.h