EOS_Mods_UpdateMod

EOS API reference page for EOS_Mods_UpdateMod

Choose your implementation method:

C

C#

This function is part of the Mods Interface.

Remarks

Starts an asynchronous task that makes a request to update the specified mod to the latest version.

See Also

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

Parameters

EOS_Mods_UpdateMod

Parameter Type And Name

Usage Information

EOS_HMods Handle

const EOS_Mods_UpdateModOptions* Options

structure containing the game and mod identifiers

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Mods_OnUpdateModCallback CompletionDelegate

a callback that is fired when the async operation completes, either successfully or in error. If the mod is up to date then the operation will complete with success.

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_OnUpdateModCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Mods_UpdateMod

Callback Parameters

EOS_Mods_OnUpdateModCallback

Parameter Type And Name

Usage Information

const EOS_Mods_UpdateModCallbackInfo* Data

A EOS_Mods_UpdateModCallbackInfo containing the output information and result

Related API Members

This function is part of the Mods Interface.

Remarks

Starts an asynchronous task that makes a request to update the specified mod to the latest version.

See Also

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

Parameters

Mods.ModsInterface.UpdateMod

Parameter Type And Name

Usage Information

UpdateModOptions options

structure containing the game and mod identifiers

object clientData

arbitrary data that is passed back to you in the CompletionDelegate

OnUpdateModCallback completionDelegate

a callback that is fired when the async operation completes, either successfully or in error. If the mod is up to date then the operation will complete with success.

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 object 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 Mods.OnUpdateModCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to {ModsInterface.UpdateMod}

Callback Parameters

Mods.OnUpdateModCallback

Parameter Type And Name

Usage Information

UpdateModCallbackInfo data

A EOS_Mods_UpdateModCallbackInfo containing the output information and result

Related API Members

Tags