D_ERROR_TEXT
This page applies to Harlequin v13.1r0 and later; and to Harlequin MultiRIP but not Harlequin Core
D_ERROR_TEXT Selector
Parameter: devErrorTextParam * error
The RIP calls this selector to obtain a character string containing message text for the error code reported in the deviceDefinition
's d_error
field, passed back in the devErrorTextParam
pointer. The message is displayed in the Output Controller.
If the plugin can provide no text for the error code, it should return ‐1. The RIP then tries to find text of its own corresponding to the error code. If it fails to do so, it uses the text for the “unknown” error. It asks the plugin for its version of this first, with another D_ERROR_TEXT
call, and if no text is supplied uses its own.
Note: Error messages can be localized externally. See the localization kit for details.
Note:
On the Macintosh, the plugin also looks for the “STR ”
resource (see “Handling code and other resources on Mac OS X”) if this selector is not supported.
typedef struct devErrorTextParam { int32 e_code;
char *e_text;
} devErrorTextParam;
e_code
The RIP sets this to the error code from the error report to which this call is a response.
e_text
The plugin should copy the characters of its error message into the string buffer pointed to by e_text
. It can be up to 256 bytes long, including the null terminator. The plugin should copy the string and its terminator, and not
assign to the pointer.