EOS API reference page for EOS_SessionSearch_SetTargetUserId

This function is part of the Sessions Interface.


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


Parameter Type And Name

Usage Information

EOS_HSessionSearch Handle

const EOS_SessionSearch_SetTargetUserIdOptions* Options

a specific target user ID to find

Related API Members