PFLobbyForceRemoveMember
Entfernen Sie eine Entität aus dem Wartebereich.
Syntax
HRESULT PFLobbyForceRemoveMember(
PFLobbyHandle lobby,
const PFEntityKey* targetMember,
bool preventRejoin,
void* asyncContext
)
Parameter
lobby PFLobbyHandle
Der Griff des Wartebereichs.
targetMember
PFEntityKey*
Das Element, das erzwungen entfernt werden soll.
preventRejoin Bool
Ein Flag, das angibt, ob targetMember nach dem Entfernen daran gehindert wird, dem Wartebereich erneut beizu treten.
asyncContext Leere*
Optional
Ein optionaler, app-definierter Kontextwert in Zeigergröße, der verwendet werden kann, um die Änderung des Abschlusszustands diesem Aufruf zuzuordnen.
Rückgabewert
Typ: HRESULT
S_OK , wenn der Aufruf erfolgreich war oder andernfalls ein Fehlercode vorliegt. Die lesbare Form des Fehlercodes kann über PFMultiplayerGetErrorMessage() abgerufen werden.
Hinweise
Dies ist ein asynchroner Vorgang. Nach erfolgreichem Abschluss wird dem Titel ein PFLobbyMemberRemovedStateChange gefolgt von pfLobbyForceRemoveMemberCompletedStateChange bereitgestellt, wobei das Feld PFLobbyForceRemoveMemberCompletedStateChange::result auf S_OKfestgelegt ist. Nach einem fehlgeschlagenen Abschluss wird dem Titel ein PFLobbyForceRemoveMemberCompletedStateChange mit dem Feld PFLobbyForceRemoveMemberCompletedStateChange::result bereitgestellt, das auf ein Fehler-hresult festgelegt ist.
Eine der lokalen PlayFab-Entitäten, die in diesem Wartebereich vorhanden sind, muss der Besitzer sein, damit dieser Vorgang erfolgreich ist. Wenn die lokale Besitzerentität, die diesen Vorgang initiiert hat, ihren Besitz verliert, status während der Vorgang ausgeführt wird, schlägt der Vorgang asynchron fehl.
Dies ist ein asynchroner Vorgang. Der über diese Methode entfernte Member wird erst aus den von PFLobbyGetMembers zurückgegebenen Listen entfernt, wenn der asynchrone Vorgang erfolgreich abgeschlossen wurde und eine PFLobbyMemberRemovedStateChange Struktur von PFMultiplayerStartProcessingLobbyStateChanges bereitgestellt wird.
Voraussetzungen
Header: PFLobby.h