Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Live Template
templateAPI 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

...

languagecpp

...

 

...

Parameters

Vardef
NamepHost
TypeMod*
Linkedtrue
TypeHostAPI
StyleParameter

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
NamehModule
Linkedtrue
TypeHostModuleHandle
StyleParameter

Opaque handle that represents your module. Pass this parameter to RegisterComponent.

 

Remarks

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