(v13) Specification concepts

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

The following specification concepts apply when working with the PFI.

Function enumeration

Plugin kit headers include an enumeration of the various PFI functions available to the plugin for an example routine called PlgFwFunction() , its ordinal number (enumeration) is called ePlgFwFunction .

PFI Data types

Most data types in the PFI are opaque: that is, the size and exact type of the data type is not normally explicitly defined. There are two kinds of data type in the PFI: opaque data variables (ODVs), which can be allocated for using the C language auto declarations (for example, FwByte bFred ;), and opaque data structures (ODSs), which are only ever referred to by reference, and for which allocator and deallocator routines are provided in the PFI's API.

The actual structure of an ODS should not be considered visible to the plugin, even if the structure happens to be defined in a header. Where necessary, functions in the PFI permit the plugin to inspect and modify the content.

Note: Plugin writers should consider all PFI data types as opaque, unless explicitly stated otherwise.