EOS_SessionSearch_Find

EOS API reference page for EOS_SessionSearch_Find

1 min to read

This function is part of the Sessions Interface.

Remarks

Find sessions matching the search criteria setup via this session 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 session by sessionid or targetuserid returns no results

  • EOS_InvalidParameters if any of the options are incorrect

Parameters

EOS_SessionSearch_Find

Parameter Type And NameUsage Information
EOS_HSessionSearch Handle
const EOS_SessionSearch_FindOptions* OptionsStructure containing information about the search criteria to use
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_SessionSearch_OnFindCallback CompletionDelegateA callback that is fired when the search operation completes, either successfully or in error