EOS_Mods_CopyModInfo

EOS API reference page for EOS_Mods_CopyModInfo

2 mins to read

This function is part of the Mods Interface.

Remarks

Get cached enumerated mods object. If successful, this data must be released by calling EOS_Mods_ModInfo_Release Types of the cached enumerated mods can be specified through EOS_Mods_CopyModInfoOptions This request may fail with an EOS_NotFound code if an enumeration of a certain type was not performed before this call.

Return Value

Success if we have cached data, or an error result if the request was invalid or we do not have cached data.

See Also

EOS_Mods_ModInfo_Release

Parameters

EOS_Mods_CopyModInfo

Parameter Type And NameUsage Information
EOS_HMods Handle
const EOS_Mods_CopyModInfoOptions* Optionsstructure containing the game identifier for which requesting enumerated mods
EOS_Mods_ModInfo** OutEnumeratedModsEnumerated mods Info. If the returned result is success, this will be set to data that must be later released, otherwise this will be set to NULL

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.