EOS_LobbySearch_CopySearchResultByIndex

EOS API reference page for EOS_LobbySearch_CopySearchResultByIndex

2 mins to read

This function is part of the Lobby Interface.

Remarks

EOS_LobbySearch_CopySearchResultByIndex is used to immediately retrieve a handle to the lobby information from a given search result. 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 index or a null pointer for the out parameter

  • EOS_IncompatibleVersion if the API version passed in is incorrect

See Also

EOS_LobbySearch_CopySearchResultByIndexOptions, EOS_LobbyDetails_Release

Parameters

EOS_LobbySearch_CopySearchResultByIndex

Parameter Type And NameUsage Information
EOS_HLobbySearch Handle
const EOS_LobbySearch_CopySearchResultByIndexOptions* OptionsStructure containing the input parameters
EOS_HLobbyDetails* OutLobbyDetailsHandleout parameter used to receive the lobby details 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.