EOS_Sessions_IsUserInSession

EOS API reference page for EOS_Sessions_IsUserInSession

Choose your implementation method:

C

C#

This function is part of the Sessions Interface.

Remarks

EOS_Sessions_IsUserInSession returns whether or not a given user can be found in a specified session

Return Value

  • EOS_Success if the user is found in the specified session

  • EOS_NotFound if the user is not found in the specified session

  • EOS_InvalidParameters if you pass an invalid invite ID or a null pointer for the out parameter

  • EOS_IncompatibleVersion if the API version passed in is incorrect

  • EOS_Invalid_ProductUserID if an invalid target user is specified

  • EOS_Sessions_InvalidSession if the session specified is invalid

Parameters

EOS_Sessions_IsUserInSession

Parameter Type And Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_IsUserInSessionOptions* Options

Structure containing the input parameters

Related API Members

This function is part of the Sessions Interface.

Remarks

{IsUserInSession} returns whether or not a given user can be found in a specified session {Result.NotFound} if the user is not found in the specified session {Result.InvalidParameters} if you pass an invalid invite ID or a null pointer for the out parameter {Result.IncompatibleVersion} if the API version passed in is incorrect {Result.InvalidProductUserID} if an invalid target user is specified {Result.SessionsInvalidSession} if the session specified is invalid

Return Value

{Result.Success} if the user is found in the specified session

Parameters

Sessions.SessionsInterface.IsUserInSession

Parameter Type And Name

Usage Information

IsUserInSessionOptions options

Structure containing the input parameters

Related API Members