EOS API reference page for EOS_Lobby_CopyLobbyDetailsHandle

This function is part of the Lobby Interface.


Create a handle to an existing lobby. 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 lobby handle was created successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_IncompatibleVersion if the API version passed in is incorrect

  • EOS_NotFound if the lobby doesn't exist


Parameter Type And Name

Usage Information

EOS_HLobby Handle

const EOS_Lobby_CopyLobbyDetailsHandleOptions* Options

Structure containing information about the lobby to retrieve

EOS_HLobbyDetails* OutLobbyDetailsHandle

The new active lobby handle or null if there was an error

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.

Related API Members