Choose your implementation method:
This function is part of the Mods Interface.
Starts an asynchronous task that makes a request to enumerate mods for the specified game.
Types of the mods to enumerate can be specified through EOS_Mods_EnumerateModsOptions
See Also
the section related to mods in eos_result.h for more details.
Parameters
EOS_Mods_EnumerateMods
|
Parameter Type And Name
|
Usage Information
|
|
EOS_HMods Handle
|
|
|
const EOS_Mods_EnumerateModsOptions* Options
|
structure containing the game identifiers
|
|
void* ClientData
|
arbitrary data that is passed back to you in the CompletionDelegate
|
|
const EOS_Mods_OnEnumerateModsCallback 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.
Because this function is asynchronous, it employs a callback of type EOS_Mods_OnEnumerateModsCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Mods_EnumerateMods
Callback Parameters
EOS_Mods_OnEnumerateModsCallback
|
Parameter Type And Name
|
Usage Information
|
|
const EOS_Mods_EnumerateModsCallbackInfo* Data
|
A EOS_Mods_EnumerateModsCallbackInfo containing the output information and result
|
This function is part of the Mods Interface.
Starts an asynchronous task that makes a request to enumerate mods for the specified game.
Types of the mods to enumerate can be specified through {EnumerateModsOptions}
See Also
the section related to mods in eos_result.h for more details.
Parameters
Mods.ModsInterface.EnumerateMods
|
Parameter Type And Name
|
Usage Information
|
|
EnumerateModsOptions options
|
structure containing the game identifiers
|
|
object clientData
|
arbitrary data that is passed back to you in the CompletionDelegate
|
|
OnEnumerateModsCallback 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 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.
Because this function is asynchronous, it employs a callback of type Mods.OnEnumerateModsCallback to report the results of its operation.
Function prototype definition for callbacks passed to {ModsInterface.EnumerateMods}
Callback Parameters
Mods.OnEnumerateModsCallback
|
Parameter Type And Name
|
Usage Information
|
|
EnumerateModsCallbackInfo data
|
A EOS_Mods_EnumerateModsCallbackInfo containing the output information and result
|
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