Harlequin RIP SDK
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
ControlData Struct Reference

Gathers together various data involved in controlling the RIP and recording its current state. More...

Data Fields

app_state_t appState
 
rip_state_t ripState
 
raster_state_t rasterState
 Enum recording state of raster output.
 
HqBool fRIPRaisedAnError
 
SwLeMONITORCALLBACKpfnMonitor
 
sw_raster_api_20230105raster_api
 Pointer to raster API.
 
RasterData raster_data
 Data for raster writer.
 
void * pJobContext
 
SwLeRIPEXITCALLBACKpfnRipExit
 
SwLeRIPREBOOTCALLBACKpfnRipReboot
 
int32 cbBuffer
 
uint8pBuffer
 
int32 nErrorLevel
 
sw_mon_type monuid
 
SkinDynamicBuffer detail
 

Detailed Description

Gathers together various data involved in controlling the RIP and recording its current state.

Field Documentation

◆ appState

app_state_t ControlData::appState

Enum value recording high-level application's calls to SwLe functions.

◆ cbBuffer

int32 ControlData::cbBuffer

Length in bytes of the pBuffer value.

◆ detail

SkinDynamicBuffer ControlData::detail

Detail of first job error.

◆ fRIPRaisedAnError

HqBool ControlData::fRIPRaisedAnError

TRUE <=> the RIP has raised an error.

◆ monuid

sw_mon_type ControlData::monuid

UID of first job error.

◆ nErrorLevel

int32 ControlData::nErrorLevel

System error report level.

◆ pBuffer

uint8* ControlData::pBuffer

A pBuffer value passed either to SwLeJobStart() or SwLeJobPs(), depending on the application state.

◆ pfnMonitor

SwLeMONITORCALLBACK* ControlData::pfnMonitor

Holds the monitor callback implementation pointer passed to SwLeStart().

◆ pfnRipExit

SwLeRIPEXITCALLBACK* ControlData::pfnRipExit

Holds the rip exit callback passed to SwLeSetRipExitFunction().

◆ pfnRipReboot

SwLeRIPREBOOTCALLBACK* ControlData::pfnRipReboot

Holds the rip reboot callback passed to SwLeSetRipRebootFunction().

◆ pJobContext

void* ControlData::pJobContext

Holds any opaque application-defined per-job context data passed to SwLeJobStart().

◆ ripState

rip_state_t ControlData::ripState

Enum value recording state of the application's underlying RIP.


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