Harlequin RIP SDK
SWMSG_ERROR Struct Reference

#include "swevents.h"

Data Fields

sw_tl_ref timeline
 
unsigned int page_number
 
HqBool fail_job
 
HqBool suppress_handling
 
sw_mon_type error_monuid
 
struct PS_STRING error_name
 
struct PS_STRING command
 
ERROR_DETAILdetail
 

Detailed Description

A job error event. This message is associated with the SWEVT_INTERPRET_ERROR and SWEVT_RENDER_ERROR events.

Field Documentation

◆ command

struct PS_STRING SWMSG_ERROR::command

Counted string for reported command name.

◆ detail

ERROR_DETAIL* SWMSG_ERROR::detail

Linked list of contextual detail items.

◆ error_monuid

sw_mon_type SWMSG_ERROR::error_monuid

The PostScript error number with message identification. See monevent.h.

◆ error_name

struct PS_STRING SWMSG_ERROR::error_name

Counted string for error name.

◆ fail_job

HqBool SWMSG_ERROR::fail_job

The event handler can set this to TRUE to indicate that the job should be marked as failing. Setting it to FALSE indicates that it shouldn't be marked as failing (but an earlier render error may have done that already). Usually, you don't want to change the RIP's decision on this. The succeed/fail status primarily affects the status reported by the job state end routines and the log messages output as a result of those.

◆ page_number

unsigned int SWMSG_ERROR::page_number

The page number on which the error was detected.

◆ suppress_handling

HqBool SWMSG_ERROR::suppress_handling

This field is FALSE on entry. For SWEVT_INTERPRET_ERROR, the event handler can set this to TRUE to indicate that normal error reporting should be suppressed. (Note that the job is already stopping at this point.) For SWEVT_RENDER_ERROR, the event handler can set this to TRUE to indicate that this error is to be ignored, and any further pages can be processed and output. (Note that unless you set fail_job to FALSE, the job will still be reported as failing.)

◆ timeline

sw_tl_ref SWMSG_ERROR::timeline

A timeline associated with the system generating the error.


The documentation for this struct was generated from the following file: