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
Parameters
EOS_Sessions_CopyActiveSessionHandle
|
Parameter Type And Name
|
Usage Information
|
|
EOS_HSessions Handle
|
|
|
const EOS_Sessions_CopyActiveSessionHandleOptions* Options
|
Structure containing information about the active session to retrieve
|
|
EOS_HActiveSession* OutSessionHandle
|
The 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.
This function is part of the Sessions Interface.
Create a handle to an existing active session.
{Result.InvalidParameters} if any of the options are incorrect
{Result.IncompatibleVersion} if the API version passed in is incorrect
{Result.NotFound} if the active session doesn't exist
Return Value
{Result.Success} if the session handle was created successfully
Parameters
Sessions.SessionsInterface.CopyActiveSessionHandle
|
Parameter Type And Name
|
Usage Information
|
|
CopyActiveSessionHandleOptions options
|
Structure containing information about the active session to retrieve
|
|
ActiveSession outSessionHandle
|
The new active session handle or null if there was an error
|
If successful, this function provides data to the caller through an output parameter. The EOS SDK will automatically handle releasing the data when your code no longer holds any reference to it; you do not need to call a "Release" function.
Was this document useful?
Thank you for the response!
You’ve marked this document as useful:
yes
You’ve marked this document as not useful:
no