This function is part of the Sessions Interface.
Remarks
Unregister a group of players with the session, freeing up space for others to join
Return Value
-
EOS_Success if the unregister completes successfully
-
EOS_NoChange if the players to unregister were not found
-
EOS_InvalidParameters if any of the options are incorrect
-
EOS_Sessions_OutOfSync if the session is out of sync and will be updated on the next connection with the backend
-
EOS_NotFound if a session to be unregister players does not exist
Parameters
EOS_Sessions_UnregisterPlayers
Parameter Type And Name | Usage Information |
---|---|
EOS_HSessions Handle | |
const EOS_Sessions_UnregisterPlayersOptions* Options | Structure containing information about the session and players to be unregistered |
void* ClientData | Arbitrary data that is passed back to you in the CompletionDelegate |
const EOS_Sessions_OnUnregisterPlayersCallback CompletionDelegate | A callback that is fired when the unregistration operation completes, either successfully or in error |
Callback Function Information
Because this function is asynchronous, it employs a callback of type EOS_Sessions_OnUnregisterPlayersCallback to report the results of its operation.
Callback Remarks
Function prototype definition for callbacks passed to EOS_Sessions_UnregisterPlayers
Callback Parameters
EOS_Sessions_OnUnregisterPlayersCallback
Parameter Type And Name | Usage Information |
---|---|
const EOS_Sessions_UnregisterPlayersCallbackInfo* Data | A EOS_Sessions_UnregisterPlayersCallbackInfo containing the output information and result |