(v13) Error reporting data types

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

The PFI error reporting mechanism defines one opaque data structure, the error state structure (PlgFwErrorState ) and no opaque data variables.

The error state structure

The basic unit of error reporting is the PlgFwErrorState . This is an opaque data structure which contains all the pertinent information about the error. The plugin allocates and initializes an error state structure using PFI functions; this is then passed by reference to functions using this style of error reporting. A simple check upon return determines whether an error occurred.

Each type of error has a corresponding ordinal value, for ease of comparison. Even if an error ordinal value is not recognized (which is possible), the error state can be checked against ordinals for higher‐ level errors to see if the reported error is a subclass of errors already known.