Live Template |
---|
template | API Function Template |
---|
|
Called by the host framework to initialise your UI component. This is a mandatory function that your UI-side module DLL must export.
Syntax
Code Block |
---|
|
extern "C" __declspec(dllexport) int InitialiseGUI(
HostAPI* pHost,
HostModuleHandle hModule
); |
Parameters
Vardef |
---|
Name | pHost |
---|
TypeMod | * |
---|
Linked | true |
---|
Type | HostAPI |
---|
Style | Parameter |
---|
|
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. |
Vardef |
---|
Name | hModule |
---|
Linked | true |
---|
Type | HostModuleHandle |
---|
Style | Parameter |
---|
|
Opaque handle that represents your module. Pass this parameter to RegisterComponent. |
After all modules are loaded, the host framework calls Initialise once for every module.
Only UI modules have InitialiseGUI called on them. Engine modules have Initialise.
See Also