Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Error rendering macro 'live-template' : No template named 'API Function Template' is accessible.

Called by the host framework to initialise your engine component. This is a mandatory function that your engine-side module DLL must export.

Syntax

Parameters

pHost
Type: HostAPI *
Pointer to the HostAPI object that represents the host framework. You can copy the object pointed to by pHost if you need to communicate with the HostAPI directly at a later stage.
hModule
Opaque handle that represents your module. Pass this parameter to RegisterComponent.
szRegistryPath
Type: LPCWSTR
The registry key under HKLM where the module's package information is located. This is the same registry key that holds the manifest file path.

Remarks

After all modules are loaded, the host framework calls Initialise once for every module.

Only engine modules have Initialise called on them. UI modules have InitialiseGUI.

See Also

  • No labels