EOS API reference page for EOS_Lobby_KickMember

2 分で読めます

This function is part of the Lobby Interface.


Kick an existing member from the lobby

Return Value

  • EOS_Success if the kick completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_Lobby_NotOwner if the calling user is not the owner of the lobby

  • EOS_NotFound if a lobby of interest does not exist



Parameter Type And NameUsage Information
EOS_HLobby Handle
const EOS_Lobby_KickMemberOptions* OptionsStructure containing information about the lobby and member to be kicked
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Lobby_OnKickMemberCallback CompletionDelegateA callback that is fired when the kick operation completes, either successfully or in error

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Lobby_OnKickMemberCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_KickMember

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Lobby_KickMemberCallbackInfo* DataA EOS_Lobby_KickMember CallbackInfo containing the output information and result