This function is part of the Sessions Interface.
Remarks
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
Parameters
EOS_Sessions_CreateSessionSearch
Parameter Type And Name | Usage Information |
---|---|
EOS_HSessions Handle | |
const EOS_Sessions_CreateSessionSearchOptions* Options | Structure containing required parameters such as the maximum number of search results |
EOS_HSessionSearch* OutSessionSearchHandle | The new search handle or null if there was an error creating the search handle |