This function is part of the Sessions Interface.
EOS_SessionDetails_CopySessionAttributeByKey is used to immediately retrieve a copy of session attribution from a given source such as a active session or a search result.
If the call returns an EOS_Success result, the out parameter, OutSessionAttribute, must be passed to EOS_SessionDetails_Attribute_Release to release the memory associated with it.
Return Value
EOS_Success if the information is available and passed out in OutSessionAttribute
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_SessionDetails_Attribute, EOS_SessionDetails_CopySessionAttributeByKeyOptions, EOS_SessionDetails_Attribute_Release
Parameters
EOS_SessionDetails_CopySessionAttributeByKey
|
Parameter Type And Name
|
Usage Information
|
|
EOS_HSessionDetails Handle
|
|
|
const EOS_SessionDetails_CopySessionAttributeByKeyOptions* Options
|
Structure containing the input parameters
|
|
EOS_SessionDetails_Attribute** OutSessionAttribute
|
Out parameter used to receive the EOS_SessionDetails_Attribute 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.
This function is part of the Sessions Interface.
EOS_SessionDetails_CopySessionAttributeByKey is used to immediately retrieve a copy of session attribution from a given source such as a active session or a search result.
If the call returns an EOS_Success result, the out parameter, OutSessionAttribute, must be passed to EOS_SessionDetails_Attribute_Release to release the memory associated with it.
Return Value
EOS_Success if the information is available and passed out in OutSessionAttribute
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_SessionDetails_Attribute, EOS_SessionDetails_CopySessionAttributeByKeyOptions, EOS_SessionDetails_Attribute_Release
Parameters
Sessions.SessionDetails.CopySessionAttributeByKey
|
Parameter Type And Name
|
Usage Information
|
|
SessionDetailsCopySessionAttributeByKeyOptions options
|
Structure containing the input parameters
|
|
SessionDetailsAttribute outSessionAttribute
|
Out parameter used to receive the EOS_SessionDetails_Attribute structure.
|
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