EOS_SessionSearch_SetTargetUserId

EOS API reference page for EOS_SessionSearch_SetTargetUserId

Choose your implementation method:

C

C#

This function is part of the Sessions Interface.

Remarks

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

a search result will only be found if this user is in a public session

Return Value

  • EOS_Success if setting this target user ID was successful

  • EOS_InvalidParameters if the target user ID is invalid or null

  • EOS_IncompatibleVersion if the API version passed in is incorrect

Parameters

EOS_SessionSearch_SetTargetUserId

Parameter Type And Name

Usage Information

EOS_HSessionSearch Handle

const EOS_SessionSearch_SetTargetUserIdOptions* Options

a specific target user ID to find

Related API Members

This function is part of the Sessions Interface.

Remarks

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

a search result will only be found if this user is in a public session

Return Value

{Result.Success} if setting this target user ID was successful

Parameters

Sessions.SessionSearch.SetTargetUserId

Parameter Type And Name

Usage Information

SessionSearchSetTargetUserIdOptions options

a specific target user ID to find

Related API Members