EOS_SessionModification_AddAttribute

EOS API reference page for EOS_SessionModification_AddAttribute

Choose your implementation method:

C

C#

This function is part of the Sessions Interface.

Remarks

Associate an attribute with this session An attribute is something that may or may not be advertised with the session. If advertised, it can be queried for in a search, otherwise the data remains local to the client

Return Value

  • EOS_Success if setting this parameter was successful

  • EOS_InvalidParameters if the attribution is missing information or otherwise invalid

  • EOS_IncompatibleVersion if the API version passed in is incorrect

Parameters

EOS_SessionModification_AddAttribute

Parameter Type And Name

Usage Information

EOS_HSessionModification Handle

const EOS_SessionModification_AddAttributeOptions* Options

Options to set the attribute and its advertised state

Related API Members

This function is part of the Sessions Interface.

Remarks

Associate an attribute with this session An attribute is something that may or may not be advertised with the session. If advertised, it can be queried for in a search, otherwise the data remains local to the client {Result.InvalidParameters} if the attribution is missing information or otherwise invalid {Result.IncompatibleVersion} if the API version passed in is incorrect

Return Value

{Result.Success} if setting this parameter was successful

Parameters

Sessions.SessionModification.AddAttribute

Parameter Type And Name

Usage Information

SessionModificationAddAttributeOptions options

Options to set the attribute and its advertised state

Related API Members