D_PLUGIN_INITIALISE (event based plugins)

This page applies to Harlequin v13.1r0 and later; and to Harlequin MultiRIP but not Harlequin Core

D_PLUGIN_INITIALISE Selector

Parameter: PlugInitParam *param

Call type: Single‐call

This is the third startup call made to the plugin. It is used to set up any state required by the plugin as a whole. D_PLUGIN_INITIALISE is followed by a call to D_SECURITY .

TEXT

      typedef struct plugInitParam { int32 version ;
      int32 memAllocated ; int32 returnCode ;
    } PlugInitParam ;

Note : By this point, the globalState pointer in the GenericPluginContext structure passed to the plugin will have been correctly initialized.

`version`	The version field should be ignored.
`memAllocated`	The RIP sets this to indicate the amount of global memory actually allocated in response to the amount requested in the `D_GEN_BOOT` call. If this is less than the amount requested (usually zero if it is), the plugin may refuse to boot by setting `returnCode` , below, appropriately.
`returnCode`	The plugin should set `returnCode` to `CONTINUE_BOOT` if the memory allocated is sufficient and the plugin can continue to operate. If not, it should set it to `ABORT_BOOT` , after which the plugin boot is aborted, and the plugin is ignored.