(v13) The MultiCallData structure

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

This structure is sent with multi‐call selectors. It allows the plugin to record the state of the operation between calls. See (v13) Single-call and multi-call selectors for details of single‐ and multi‐ call selectors.

TEXT

        typedef struct multiCallData { int32 stateNum ; PluginState ps ;
        int32 done ;
    } MultiCallData ;

stateNum (MultiCallData)

Type: int32

The plugin can use this field to record the state of the operation from call to call. The RIP sets it to zero before the first call in each multi‐call, but after that it is available for the plugin's use.

ps (MultiCallData)

Type: PluginState

Space available to the plugin to store any further state information from call to call. This information is not preserved between different multi‐calls.

done (MultiCallData)

Type: int32

Initially set to zero by the RIP, this field should be set to a non‐zero value when the operation is complete.