EOS_SessionDetails_CopySessionAttributeByIndex

EOS API reference page for EOS_SessionDetails_CopySessionAttributeByIndex

Choose your implementation method:

C

C#

This function is part of the Sessions Interface.

Remarks

EOS_SessionDetails_CopySessionAttributeByIndex 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_CopySessionAttributeByIndexOptions, EOS_SessionDetails_Attribute_Release

Parameters

EOS_SessionDetails_CopySessionAttributeByIndex

Parameter Type And Name

Usage Information

EOS_HSessionDetails Handle

const EOS_SessionDetails_CopySessionAttributeByIndexOptions* 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.

Related API Members

This function is part of the Sessions Interface.

Remarks

{CopySessionAttributeByIndex} 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 {Result.Success} result, the out parameter, OutSessionAttribute, must be passed to {Release} to release the memory associated with it. {Result.InvalidParameters} if you pass a null pointer for the out parameter {Result.IncompatibleVersion} if the API version passed in is incorrect

Return Value

{Result.Success} if the information is available and passed out in OutSessionAttribute

See Also

{SessionDetailsAttribute}, {SessionDetailsCopySessionAttributeByIndexOptions}, {Release}

Parameters

Sessions.SessionDetails.CopySessionAttributeByIndex

Parameter Type And Name

Usage Information

SessionDetailsCopySessionAttributeByIndexOptions 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.

Related API Members