EOS API reference page for EOS_Lobby_CreateLobbySearch

This function is part of the Lobby Interface.


Create a lobby search handle. This handle may be modified to include various search parameters. Searching is possible in three methods, all mutually exclusive

  • set the lobby ID to find a specific lobby

  • set the target user ID to find a specific user

  • set lobby parameters to find an array of lobbies that match the search criteria (not available yet)

Return Value

  • EOS_Success if the search creation completes successfully

  • EOS_InvalidParameters if any of the options are incorrect


Parameter Type And Name

Usage Information

EOS_HLobby Handle

const EOS_Lobby_CreateLobbySearchOptions* Options

Structure containing required parameters such as the maximum number of search results

EOS_HLobbySearch* OutLobbySearchHandle

The new search handle or null if there was an error creating the search handle

Related API Members