EOS_Sessions_CopySessionHandleForPresence

EOS API reference page for EOS_Sessions_CopySessionHandleForPresence

Choose your implementation method:

C

C#

This function is part of the [Sessions Interface](Interfaces/Sessions).

Remarks

EOS_Sessions_CopySessionHandleForPresence is used to immediately retrieve a handle to the session information which was marked with bPresenceEnabled on create or join. 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 there is no session with bPresenceEnabled

See Also

EOS_Sessions_CopySessionHandleForPresenceOptions, EOS_SessionDetails_Release

Parameters

EOS_Sessions_CopySessionHandleForPresence

Parameter Type And Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_CopySessionHandleForPresenceOptions* 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

This function is part of the [Sessions Interface](Interfaces/Sessions).

Remarks

EOS_Sessions_CopySessionHandleForPresence is used to immediately retrieve a handle to the session information which was marked with bPresenceEnabled on create or join. 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 there is no session with bPresenceEnabled

See Also

EOS_Sessions_CopySessionHandleForPresenceOptions, EOS_SessionDetails_Release

Parameters

Sessions.SessionsInterface.CopySessionHandleForPresence

Parameter Type And Name

Usage Information

CopySessionHandleForPresenceOptions options

Structure containing the input parameters

SessionDetails outSessionHandle

out parameter used to receive the session handle

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.

Related API Members