EOS API reference page for EOS_Mods_InstallMod

This function is part of the Mods Interface.


Starts an asynchronous task that makes a request to install the specified mod.

See Also

the section related to mods in eos_result.h for more details.


Parameter Type And Name

Usage Information

EOS_HMods Handle

const EOS_Mods_InstallModOptions* Options

structure containing the game and mod identifiers

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Mods_OnInstallModCallback CompletionDelegate

a callback that is fired when the async operation completes, either successfully or in error

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Mods_OnInstallModCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Mods_InstallMod

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Mods_InstallModCallbackInfo* Data

A EOS_Mods_InstallModCallbackInfo containing the output information and result

Related API Members