EOS_Lobby_CopyLobbyDetailsHandleByUiEventId

EOS API reference page for EOS_Lobby_CopyLobbyDetailsHandleByUiEventId

2 分で読める

This function is part of the Lobby Interface.

Remarks

EOS_Lobby_CopyLobbyDetailsHandleByUiEventId is used to immediately retrieve a handle to the lobby information from after notification of an join game 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 ui event ID

  • EOS_IncompatibleVersion if the API version passed in is incorrect

  • EOS_NotFound If the invite ID cannot be found

See Also

EOS_Lobby_CopyLobbyDetailsHandleByUiEventIdOptions, EOS_LobbyDetails_Release

Parameters

EOS_Lobby_CopyLobbyDetailsHandleByUiEventId

Parameter Type And NameUsage Information
EOS_HLobby Handle
const EOS_Lobby_CopyLobbyDetailsHandleByUiEventIdOptions* OptionsStructure containing the input parameters
EOS_HLobbyDetails* OutLobbyDetailsHandleout 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.