Choose your implementation method:
This function is part of the Lobby Interface.
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
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 Lobby Interface.
{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 {Result.Success} result, the out parameter, OutAttribute, must be passed to {LobbyInterface.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 OutAttribute
See Also
{Attribute}, {LobbyDetailsCopyAttributeByKeyOptions}, {LobbyInterface.Release}
Parameters
Lobby.LobbyDetails.CopyAttributeByKey
|
Parameter Type And Name
|
Usage Information
|
|
LobbyDetailsCopyAttributeByKeyOptions options
|
Structure containing the input parameters
|
|
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. 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