EOS_LobbySearch_Find

EOS API reference page for EOS_LobbySearch_Find

Choose your implementation method:

C

C#

This function is part of the Lobby Interface.

Remarks

Find lobbies matching the search criteria setup via this lobby search handle. When the operation completes, this handle will have the search results that can be parsed

Return Value

  • EOS_Success if the find operation completes successfully

  • EOS_NotFound if searching for an individual lobby by lobby ID or target user ID returns no results

  • EOS_InvalidParameters if any of the options are incorrect

Parameters

EOS_LobbySearch_Find

Parameter Type And Name

Usage Information

EOS_HLobbySearch Handle

const EOS_LobbySearch_FindOptions* Options

Structure containing information about the search criteria to use

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_LobbySearch_OnFindCallback CompletionDelegate

A callback that is fired when the search operation completes, either successfully or in error

Related API Members

This function is part of the Lobby Interface.

Remarks

Find lobbies matching the search criteria setup via this lobby search handle. When the operation completes, this handle will have the search results that can be parsed {Result.NotFound} if searching for an individual lobby by lobby ID or target user ID returns no results {Result.InvalidParameters} if any of the options are incorrect

Return Value

{Result.Success} if the find operation completes successfully

Parameters

Lobby.LobbySearch.Find

Parameter Type And Name

Usage Information

LobbySearchFindOptions options

Structure containing information about the search criteria to use

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

LobbySearchOnFindCallback completionDelegate

A callback that is fired when the search operation completes, either successfully or in error

Related API Members

Tags