IHYCrossPlatformModule
Overview
The IHYCrossPlatformModule interface defines the cross platform module. This interface is used by the managed hosts to interact with unmanamged plugins.
This interface is implemented by the ModuleController class that provides all the necessary methods for cross platform interaction between unmanaged modules and managed hosts.
Location
- Reference: Hydra.fx
- Namespace: Hydra
- Platforms: Island
-
Ancestry:
- IDispatch | IHYCrossPlatformInterface | IHYCrossPlatformModule Island-Ubuntu
- __struct_IDispatch | IHYCrossPlatformInterface | IHYCrossPlatformModule Island-Windows
- IDispatch | IHYCrossPlatformInterface | IHYCrossPlatformModule Island-Ubuntu
Required Methods
CreateInstance stdcall
Creates a new instance of the plugin whose name is specified by the aPluginName
parameter.
method CreateInstance(aPluginName: OleString; out aResult: IHYCrossPlatformPlugin): HRESULT
HRESULT CreateInstance(OleString aPluginName, out IHYCrossPlatformPlugin aResult)
func CreateInstance(_ aPluginName: OleString, _ aResult: IHYCrossPlatformPlugin) -> HRESULT
Function CreateInstance(aPluginName As OleString, <OutAttribute> ByRef aResult As IHYCrossPlatformPlugin) As HRESULT
Parameters:
- aPluginName: Name of the plugin
- aResult: result
get_Plugin stdcall
Returns the reference to a plugin descriptor with specified index.
method get_Plugin(aIndex: Int32; out aResult: IHYCrossPlatformPluginDescriptor): HRESULT
HRESULT get_Plugin(Int32 aIndex, out IHYCrossPlatformPluginDescriptor aResult)
func get_Plugin(_ aIndex: Int32, _ aResult: IHYCrossPlatformPluginDescriptor) -> HRESULT
Function get_Plugin(aIndex As Int32, <OutAttribute> ByRef aResult As IHYCrossPlatformPluginDescriptor) As HRESULT
Parameters:
- aIndex: Index of the plugin.
- aResult: result
get_PluginCount stdcall
Returns the number of plugins in the current module.
method get_PluginCount(out aResult: Int32): HRESULT
HRESULT get_PluginCount(out Int32 aResult)
func get_PluginCount(_ aResult: Int32) -> HRESULT
Function get_PluginCount(<OutAttribute> ByRef aResult As Int32) As HRESULT
Parameters:
- aResult: result
GetModuleController stdcall
Returns the interface of the current module controller.
method GetModuleController(out aResult: IHYCrossPlatformModuleController): HRESULT
HRESULT GetModuleController(out IHYCrossPlatformModuleController aResult)
func GetModuleController(_ aResult: IHYCrossPlatformModuleController) -> HRESULT
Function GetModuleController(<OutAttribute> ByRef aResult As IHYCrossPlatformModuleController) As HRESULT
Parameters:
- aResult: result