EOS API reference page for EOS_Lobby_SendInvite

3 mins to read

This function is part of the Lobby Interface.


Send an invite to another user. User must be a member of the lobby or else the call will fail

Return Value

  • EOS_Success if the send invite completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_NotFound if the lobby to send the invite from does not exist



Parameter Type And NameUsage Information
EOS_HLobby Handle
const EOS_Lobby_SendInviteOptions* OptionsStructure containing information about the lobby and user to invite
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Lobby_OnSendInviteCallback CompletionDelegateA callback that is fired when the send invite operation completes, either successfully or in error

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_SendInvite

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Lobby_SendInviteCallbackInfo* DataA EOS_Lobby_SendInvite CallbackInfo containing the output information and result