EOS API reference page for EOS_Sessions_CopySessionHandleByUiEventId

This function is part of the Sessions Interface.


EOS_Sessions_CopySessionHandleByUiEventId is used to immediately retrieve a handle to the session information from after notification of a join game event. If the call returns an EOS_Success result, the out parameter, OutSessionHandle, must be passed to EOS_SessionDetails_Release to release the memory associated with it.

Return Value

  • EOS_Success if the information is available and passed out in OutSessionHandle

  • 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_NotFound if the invite ID cannot be found

See Also

EOS_Sessions_CopySessionHandleByUiEventIdOptions, EOS_SessionDetails_Release


Parameter Type And Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_CopySessionHandleByUiEventIdOptions* Options

Structure containing the input parameters

EOS_HSessionDetails* OutSessionHandle

out parameter used to receive the session handle

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.

Related API Members