EOS API reference page for EOS_Sessions_CopyActiveSessionHandle

1 min to read

This function is part of the Sessions Interface.


Create a handle to an existing active session.

Return Value

  • EOS_Success if the session handle was created successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_IncompatibleVersion if the API version passed in is incorrect

  • EOS_NotFound if the active session doesn't exist



Parameter Type And NameUsage Information
EOS_HSessions Handle
const EOS_Sessions_CopyActiveSessionHandleOptions* OptionsStructure containing information about the active session to retrieve
EOS_HActiveSession* OutSessionHandleThe new active session handle or null if there was an error

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.