(v13) Abort output and write text

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

The recommended way of aborting a job is to use the guirip_abort_output() function, part of the

RDR_API_GUISKIN interface (current version 20140826 ).

See the section on API detection and redefinition in the Harlequin API Reference Manual for information on how to find an interface with RDR. The interface provides two functions: to abort output and to write text to the monitor window.

Abort output

Calling the guirip_abort_output() function stops output for a job. In Single modes it interrupts and cancels the current job, whereas in multiple modes it disables output in the Output Controller and moves the current page being output back into the Active Queue.

The jobNumber argument is currently not used. Therefore, the job currently being output is aborted. This argument may be implemented in a future release.

The prototype for the function is:

void HQNCALL guirip_abort_output(int32 jobNumber);

with example of its use as:

guirip_abort_output(123);

Write text to the monitor window

When writing text to the monitor window the *s parameter specifies the text to write. The prototype for the function is:

void HQNCALL guirip_monitor(char * s);

with example of its use as:

guirip_monitor("Output this text");

Note: You should note that guirip_monitor() outputs the text immediately, unlike pluginOutMonitor() which stores it in a buffer (of quite small capacity), until the RIP asks for it in a selector call.