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
Parameters
EOS_Lobby_KickMember
|
Parameter Type And Name
|
Usage Information
|
|
EOS_HLobby Handle
|
|
|
const EOS_Lobby_KickMemberOptions* Options
|
Structure containing information about the lobby and member to be kicked
|
|
void* ClientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
|
const EOS_Lobby_OnKickMemberCallback CompletionDelegate
|
A callback that is fired when the kick 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_Lobby_OnKickMemberCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Lobby_KickMember
Callback Parameters
EOS_Lobby_OnKickMemberCallback
|
Parameter Type And Name
|
Usage Information
|
|
const EOS_Lobby_KickMemberCallbackInfo* Data
|
A EOS_Lobby_KickMember CallbackInfo containing the output information and result
|
This function is part of the Lobby Interface.
Kick an existing member from the lobby
{Result.InvalidParameters} if any of the options are incorrect
{Result.LobbyNotOwner} if the calling user is not the owner of the lobby
{Result.NotFound} if a lobby of interest does not exist
Return Value
{Result.Success} if the kick completes successfully
Parameters
Lobby.LobbyInterface.KickMember
|
Parameter Type And Name
|
Usage Information
|
|
KickMemberOptions options
|
Structure containing information about the lobby and member to be kicked
|
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
|
OnKickMemberCallback completionDelegate
|
A callback that is fired when the kick 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 object 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 Lobby.OnKickMemberCallback to report the results of its operation.
Function prototype definition for callbacks passed to {LobbyInterface.KickMember}
Callback Parameters
Lobby.OnKickMemberCallback
|
Parameter Type And Name
|
Usage Information
|
|
KickMemberCallbackInfo data
|
A EOS_Lobby_KickMember CallbackInfo 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