The PluginStioQuery structure | Helix Documentation

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

PluginStioQuery Structure

This structure is used by the RIP to ask a plugin for information about its private parameters. It is used as a parameter in the D_GETSTIOTEMPL , D_CBSTIOTEMPL , D_GETSTIODATA and D_CBSTIODATA selector calls.

This structure is defined in the header file gdevdlg.h .

  typedef struct PluginStioQuery { int32 psc;
  int32 deviceID;
  void *pv;
  } PluginStioQuery;

psc

The RIP sets this field to indicate what kind of information is being requested from the plugin, as follows:

`pscOutput`	Information associated with an output plugin.
`pscInputClass`	Information associated with an input plugin channel class. Not used at present.
`pscInputDevice`	Information associated with an input channel.

deviceID

Note: This field is only relevant to input plugins.

The RIP sets this to the channelClassID of the channel class or channel it is asking about, to whether psc is pscInputClass or pscInputDevice respectively.

The plugin originally specifies the channelClassID in the channelClassDescription structure, in response to a D_GET_CHANNEL_CLASS_DESCRIPTIONS call.

The RIP sets this to point to an area of memory in which the plugin should place its answer to the request. This might be a copy of the appropriate DICTSTRUCTION when the structure is used in the D_GETSTIOTEMPL selector call. See D_GETSTIOTEMPL .