(v13) D_ERROR_ICON

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

D_ERROR_ICON Selector

Parameter: devErrorIconParam * error

The RIP calls this selector to obtain a resource identifier icon for the error code reported in d_error . The icon is displayed in the Output Controller.

If the plugin can provide no icon for the error code, it should return ‐1. The RIP then tries to find an icon of its own corresponding to the error code. If it fails to do so, it will use the icon for the “unknown” error. It asks the plugin for its resource identifier for its own “unknown error” icon, with another D_ERROR_ICON call, and if ‐1 is again returned, uses its own.

Note: On Windows, the icon resources are compiled into the plugin.

      typedef struct devErrorIconParam { int32 version;
      int32 e_code;
      IconId e_icon;
    } devErrorIconParam;

version

The plugin should ignore this field. It is obsolete. Instead, perform version checking with the

CHECK_VERSION macro in the D_GET_IDENTITY call, and use that result throughout.

e_code

The RIP sets this to the error code from the error report to which this call is a response.

e_icon

This is a pointer to a structure, IconId , whose contents depend on the platform.

Windows versions use icons in resources created by a dialog editor such as Microsoft's AppStudio or Apple's ResEdit, identified by a single number.

Icons should be 32 x 32 pixels. Icons for Windows 7 and later may be in “high color” format, but the plugin should include and select 256‐color ones if older OS versions are likely to be encountered.

See the appendix for your platform.