This function is part of the Sessions Interface.
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
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type EOS_Sessions_OnUnregisterPlayersCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Sessions_UnregisterPlayers
Callback Parameters
EOS_Sessions_OnUnregisterPlayersCallback
This function is part of the Sessions Interface.
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
Sessions.SessionsInterface.UnregisterPlayers
|
Parameter Type And Name
|
Usage Information
|
|
UnregisterPlayersOptions options
|
Structure containing information about the session and players to be unregistered
|
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
|
OnUnregisterPlayersCallback completionDelegate
|
A callback that is fired when the unregistration operation completes, either successfully or in error
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type EOS_Sessions_OnUnregisterPlayersCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Sessions_UnregisterPlayers
Callback Parameters
Sessions.OnUnregisterPlayersCallback
|
Parameter Type And Name
|
Usage Information
|
|
UnregisterPlayersCallbackInfo data
|
A EOS_Sessions_UnregisterPlayersCallbackInfo containing the output information and result
|
Was this document useful?
Thank you for the response!
You’ve marked this document as useful:
yes
You’ve marked this document as not useful:
no