(v13) The PluginState structure

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

This structure is used to store state information for an input plugin channel. This state information comprises two integers and a pointer to a block of memory, allocated according to the channel's needs during the D_IP_CHANNEL_CLASS_DESCRIPTIONS selector call.

The two integers are always available in each context, to avoid having to go to the trouble of asking for memory for such simple information.

Each channel has one of these structures, found in its channelContext structure. Each channel class has one as well, found in its channelClassContext structure.

      typedef struct pluginState { void *memory;
      int32 int1, int2;
    } PluginState;

memory (PluginState)

Type: void*

A pointer to the memory allocated by the RIP for the channel class or channel. (Which it is depends on whether the PluginState structure is appearing in a channelClassContext or channelContext .)

int1 and int2 (PluginState)

Type: int32

These two integers are available to the plugin for storing state information. The RIP ignores them.