EOS API reference page for EOS_Sessions_CreateSessionSearch


This function is part of the Sessions Interface.


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

  • set the session ID to find a specific session
  • set the target user ID to find a specific user
  • set session parameters to find an array of sessions that match the search criteria

Return Value

  • EOS_Success if the search creation completes successfully

  • EOS_InvalidParameters if any of the options are incorrect



Parameter Type And NameUsage Information
EOS_HSessions Handle
const EOS_Sessions_CreateSessionSearchOptions* OptionsStructure containing required parameters such as the maximum number of search results
EOS_HSessionSearch* OutSessionSearchHandleThe new search handle or null if there was an error creating the search handle