EOS_LobbyDetails_CopyAttributeByKey

EOS API reference page for EOS_LobbyDetails_CopyAttributeByKey

2 分で読めます

This function is part of the Lobby Interface.

Remarks

EOS_LobbyDetails_CopyAttributeByKey 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_CopyAttributeByKeyOptions, EOS_Lobby_Attribute_Release

Parameters

EOS_LobbyDetails_CopyAttributeByKey

Parameter Type And NameUsage Information
EOS_HLobbyDetails Handle
const EOS_LobbyDetails_CopyAttributeByKeyOptions* OptionsStructure containing the input parameters
EOS_Lobby_Attribute** OutAttributeOut 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.