(v13) PluginLib_ip_out_release

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

PluginLib_ip_out_release Function

TEXT

    int32 PluginLib_ip_out_release(
        PLUGIN_BUFFER * dataOutBuffer,
        int32 request
        );

Advances the buffer pointer by request contiguous bytes, indicating that the plugin has consumed them.

If nothing has been reserved, the function returns IPPL_NOT_RESERVED . If request is greater than the amount reserved, the function returns IPPL_TOO_BIG . Otherwise, it returns IPPL_OK .

The amount of buffer reserved is reset to zero even if request is less than that originally reserved the reservation is considered cancelled and the unread data is available on the next request .