CAPS Universe documentation  1.0.4
All you need to know to be successful
Functions
Error handling when printing

Provide more detailed information about failures. More...

Functions

void caps_drv_job_canceled (struct caps_drv *cdrv, const char *message)
 

Detailed Description

Function Documentation

◆ caps_drv_job_canceled()

void caps_drv_job_canceled ( struct caps_drv cdrv,
const char *  message 
)

Setup a detailed error message why a job was aborted/canceled

Parameters
[in]cdrvlibcapsdriver handle
[in]messageDetailed error description (read NLS hint below)

This function is intended to be used if your callbacks return an error code which should terminate the current job. Since the framework can only add generic error descriptions, you can setup here a more detailed error message instead, to help the user to understand, what exactly had failed.

Note
For the message language follow the same rule as for caps_pp_job_state_update()