EOS_SessionSearch_SetSessionId

EOS API reference page for EOS_SessionSearch_SetSessionId

Choose your implementation method:

C

C#

This function is part of the Sessions Interface.

Remarks

Set a session ID to find and will return at most one search result. Setting TargetUserId or SearchParameters will result in EOS_SessionSearch_Find failing

Return Value

  • EOS_Success if setting this session ID was successful

  • EOS_InvalidParameters if the session ID is invalid or null

  • EOS_IncompatibleVersion if the API version passed in is incorrect

Parameters

EOS_SessionSearch_SetSessionId

Parameter Type And Name

Usage Information

EOS_HSessionSearch Handle

const EOS_SessionSearch_SetSessionIdOptions* Options

A specific session ID for which to search

Related API Members

This function is part of the Sessions Interface.

Remarks

Set a session ID to find and will return at most one search result. Setting TargetUserId or SearchParameters will result in {Find} failing {Result.InvalidParameters} if the session ID is invalid or null {Result.IncompatibleVersion} if the API version passed in is incorrect

Return Value

{Result.Success} if setting this session ID was successful

Parameters

Sessions.SessionSearch.SetSessionId

Parameter Type And Name

Usage Information

SessionSearchSetSessionIdOptions options

A specific session ID for which to search

Related API Members