PFLobbyLeave
Fordern Sie einen oder alle lokalen Benutzer auf, den Wartebereich zu verlassen.
Syntax
HRESULT PFLobbyLeave(
PFLobbyHandle lobby,
const PFEntityKey* localUser,
void* asyncContext
)
Parameter
lobby PFLobbyHandle
Der Griff des Wartebereichs.
localUser
PFEntityKey*
Optional
Ein optionaler Wert, der angibt, ob ein bestimmter lokaler Benutzer den Wartebereich verlassen soll. Wenn dieser Wert nullptr ist, verlassen alle lokalen Benutzer den Wartebereich.
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
Diese Methode stellt einen asynchronen Vorgang in die Warteschlange, um einen oder alle lokalen Benutzer aus dem Wartebereich zu entfernen. Nach Abschluss des Vorgangs wird ein PFLobbyLeaveLobbyCompletedStateChange bereitgestellt, der angibt, dass der Vorgang abgeschlossen wurde.
Diese Methode garantiert nicht, dass der Urlaub erfolgreich ist. Der Vorgang kann aufgrund von Netzwerk- oder Dienstfehlern fehlschlagen. Wenn der Ausreiseversuch fehlschlägt, aber erneut versucht werden kann, versucht die Bibliothek weiterhin, den Vorgang zu verlassen. Andernfalls trennt der lokale Client die angeforderten lokalen Mitglieder vom Wartebereich, belässt sie jedoch als Mitglieder. Sie bleiben als getrennte Mitglieder, bis sie wieder beitreten.
Diese Methode kann nicht von einer game_server-Entität aufgerufen werden.
Voraussetzungen
Header: PFLobby.h