EOS API reference page for EOS_LobbyDetails_CopyAttributeByIndex

This function is part of the Lobby Interface.


EOS_LobbyDetails_CopyAttributeByIndex is used to immediately retrieve a copy of a lobby attribute from a given source such as a existing lobby or a search result. If the call returns an EOS_Success result, the out parameter, OutAttribute, must be passed to EOS_Lobby_Attribute_Release to release the memory associated with it.

Return Value

  • EOS_Success if the information is available and passed out in OutAttribute

  • 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_Lobby_Attribute, EOS_LobbyDetails_CopyAttributeByIndexOptions, EOS_Lobby_Attribute_Release


Parameter Type And Name

Usage Information

EOS_HLobbyDetails Handle

const EOS_LobbyDetails_CopyAttributeByIndexOptions* Options

Structure containing the input parameters

EOS_Lobby_Attribute** OutAttribute

Out parameter used to receive the EOS_Lobby_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