EOS API reference page for EOS_Sessions_UnregisterPlayers

3 分で読めます

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



Parameter Type And NameUsage Information
EOS_HSessions Handle
const EOS_Sessions_UnregisterPlayersOptions* OptionsStructure containing information about the session and players to be unregistered
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Sessions_OnUnregisterPlayersCallback CompletionDelegateA 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


Parameter Type And NameUsage Information
const EOS_Sessions_UnregisterPlayersCallbackInfo* DataA EOS_Sessions_UnregisterPlayersCallbackInfo containing the output information and result