This function is part of the [Lobby Interface](Interfaces/Lobby).
EOS_Lobby_CopyLobbyDetailsHandleByInviteId is used to immediately retrieve a handle to the lobby information from after notification of an invite
If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.
Return Value
EOS_Success if the information is available and passed out in OutLobbyDetailsHandle
EOS_InvalidParameters if you pass an invalid invite ID or a null pointer for the out parameter
EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_NotFound If the invite ID cannot be found
See Also
EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions, EOS_LobbyDetails_Release
Parameters
EOS_Lobby_CopyLobbyDetailsHandleByInviteId
|
Parameter Type And Name
|
Usage Information
|
|
EOS_HLobby Handle
|
|
|
const EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions* Options
|
Structure containing the input parameters
|
|
EOS_HLobbyDetails* OutLobbyDetailsHandle
|
out parameter used to receive the lobby handle
|
If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.
This function is part of the [Lobby Interface](Interfaces/Lobby).
EOS_Lobby_CopyLobbyDetailsHandleByInviteId is used to immediately retrieve a handle to the lobby information from after notification of an invite
If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.
Return Value
EOS_Success if the information is available and passed out in OutLobbyDetailsHandle
EOS_InvalidParameters if you pass an invalid invite ID or a null pointer for the out parameter
EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_NotFound If the invite ID cannot be found
See Also
EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions, EOS_LobbyDetails_Release
Parameters
Lobby.LobbyInterface.CopyLobbyDetailsHandleByInviteId
|
Parameter Type And Name
|
Usage Information
|
|
CopyLobbyDetailsHandleByInviteIdOptions options
|
Structure containing the input parameters
|
|
LobbyDetails outLobbyDetailsHandle
|
out parameter used to receive the lobby handle
|
If successful, this function provides data to the caller through an output parameter. The EOS SDK will automatically handle releasing the data when your code no longer holds any reference to it; you do not need to call a "Release" function.
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