EOS API reference page for EOS_ActiveSession_CopyInfo

2 mins to read

This function is part of the Sessions Interface.


EOS_ActiveSession_CopyInfo is used to immediately retrieve a copy of active session information If the call returns an EOS_Success result, the out parameter, OutActiveSessionInfo, must be passed to EOS_ActiveSession_Info_Release to release the memory associated with it.

Return Value

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

  • EOS_InvalidParameters if you pass a null pointer for the out parameter

  • EOS_IncompatibleVersion if the API version passed in is incorrect

See Also

EOS_ActiveSession_Info, EOS_ActiveSession_CopyInfoOptions, EOS_ActiveSession_Info_Release



Parameter Type And NameUsage Information
EOS_HActiveSession Handle
const EOS_ActiveSession_CopyInfoOptions* OptionsStructure containing the input parameters
EOS_ActiveSession_Info** OutActiveSessionInfoOut parameter used to receive the EOS_ActiveSession_Info structure.

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.