D_GETSTIOTEMPL

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

D_GETSTIOTEMPL Selector

Parameter: PluginStioQuery * returndictstructions

The RIP makes this call to get the DICTSTRUCTION structures which form the template for plugin parameters: their types, names and so on. See The DICTSTRUCTION structure .

Note: The RIP only calls this selector if a preceding D_SELECTOR_SUPPORT call indicates that it is sup‐ ported by the plugin.

The RIP sets the pv element of the PluginStioQuery structure to an appropriately aligned pointer to a region of memory at least the size returned from D_CBSTIOTEMPL . The plugin should fill this memory with an array of DICTSTRUCTION structures, using the library routines PluginLibStioSize and PluginLibStioFixUp , described in Plugin dialog utility functions .

Note: There must not be any pointers in the returned data referring to data inside the plugin. The library routines help ensure this is correct.

A plugin typically uses PluginStioFixUp to copy a statically defined structure in order to complete this information.