(v13) Pluggable font return codes

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

Unless otherwise noted, all calls return a success/failure code and, except where indicated, such codes are prefixed with SW_PFIN_ERROR_ For example, SW_PFIN_SUCCESS (zero) means the operation was successful. SW_PFIN_ERROR_SYNTAX indicates a programming fault a null pointer, or an out-of-range argument. Additional error codes may be returned by some calls, and these are documented below the call description.

SW_PFIN_SUCCESS	(zero) operation successful.
SYNTAX	PFIN context invalid; null pointer; out of range argument. From PFIN : This indicates a programming error.
UNKNOWN	File/glyph not found. From module : Glyph not found /notdef may be used instead.
INVALID	Invalid font. From module: Invalid font. Such a font may be handed to other font modules. Otherwise, it will be raised by PFIN as INVALIDFONT.
UNSUPPORTED	The module cannot handle the font, though it might not be invalid. From module : Such a font will usually be handed to other font modules. Otherwise, it will be raised by PFIN as INVALIDFONT.
RANGE	Value out of range. From module : This will be raised by PFIN as RANGECHECK.
MEMORY	Insufficient memory (an `alloc` failed). From PFIN: The module may try another strategy, or return the error to PFIN. From module : PFIN may try again, or will raise VMERROR.
SW_PFIN_FAILED	Operation failed (that is, none of the above). From module : PFIN will raise this as INVALIDFONT it will not be passed on.