1 /*________________________________ epson-escpr-err.h ________________________________*/
\r
3 /* 1 2 3 4 5 6 7 8 */
\r
4 /*34567890123456789012345678901234567890123456789012345678901234567890123456789012345678*/
\r
5 /*******************************************|********************************************/
\r
7 * Copyright (c) 2009 Seiko Epson Corporation All rights reserved.
\r
9 * Copyright protection claimed includes all forms and matters of
\r
10 * copyrightable material and information now allowed by statutory or judicial
\r
11 * law or hereinafter granted, including without limitation, material generated
\r
12 * from the software programs which are displayed on the screen such as icons,
\r
13 * screen display looks, etc.
\r
16 /*******************************************|********************************************/
\r
18 /* Epson ESC/PR Error Definitions */
\r
20 /*******************************************|********************************************/
\r
21 #ifndef __EPSON_ESCPR_ERR_H__
\r
22 #define __EPSON_ESCPR_ERR_H__
\r
27 /*------------------------------------ Includes -------------------------------------*/
\r
28 /*******************************************|********************************************/
\r
29 #include "epson-typedefs.h"
\r
31 /*------------------------------------- Data Types -------------------------------------*/
\r
32 /*******************************************|********************************************/
\r
34 /*---------------------------------- Generic Macros ---------------------------------*/
\r
35 /*******************************************|********************************************/
\r
37 /*----------------------------------- Definitions ------------------------------------*/
\r
38 /*******************************************|********************************************/
\r
40 /*---------------------- Normal Return Value of ESC/P-R Lib API ----------------------*/
\r
41 /*******************************************|********************************************/
\r
42 #define EPS_JOB_CANCELED 40 /* Printing job is canceled by user */
\r
43 #define EPS_OUT_OF_BOUNDS 41 /* Print band is in out of printable area */
\r
44 #define EPS_FIND_CANCELED 42 /* Find printer is canceled by user */
\r
46 /*----------------------- Error Return Value of ESC/P-R Lib API ----------------------*/
\r
47 /*******************************************|********************************************/
\r
48 enum EPS_RUN_TIME_ERROR {
\r
50 /*** -------------------------------------------------------------------------------*/
\r
51 EPS_ERR_NONE = 0, /* Routine / Action completed successfully */
\r
53 /*** Global Error */
\r
54 /*** -------------------------------------------------------------------------------*/
\r
55 EPS_ERR_OPR_FAIL = -1000, /* Generic / Internal Error */
\r
56 EPS_ERR_MEMORY_ALLOCATION = -1001, /* Memory Allocation Error */
\r
57 EPS_ERR_PRINTER_ERR_OCCUR = -1003, /* The error occurred by Printer */
\r
59 EPS_ERR_PROTOCOL_NOT_SUPPORTED = -1010, /* Unsupported function Error (protocol) */
\r
60 EPS_ERR_NEED_BIDIRECT = -1011, /* Need Bi-Directional Communication Mode */
\r
61 EPS_ERR_INVALID_CALL = -1012, /* Invalid function call */
\r
62 EPS_ERR_INVALID_VERSION = -1013, /* Invalid structure version */
\r
63 EPS_ERR_INVALID_DATATYPE = -1014, /* Invalid data type */
\r
64 EPS_ERR_LANGUAGE_NOT_SUPPORTED = -1015, /* Unsupported function Error (language) */
\r
66 /*** Library Status Error */
\r
67 /*** -------------------------------------------------------------------------------*/
\r
68 EPS_ERR_LIB_INTIALIZED = -1050, /* Lib already initialized */
\r
69 EPS_ERR_LIB_NOT_INITIALIZED = -1051, /* Lib not initialized */
\r
70 EPS_ERR_JOB_NOT_INITIALIZED = -1052, /* Start page before start job */
\r
71 EPS_ERR_JOB_NOT_CLOSED = -1053, /* Started new job before closing open job */
\r
72 EPS_ERR_PAGE_NOT_INITIALIZED = -1054, /* Close page before start page */
\r
73 EPS_ERR_PAGE_NOT_CLOSED = -1055, /* Started new page before closing open page */
\r
76 /*** -------------------------------------------------------------------------------*/
\r
77 EPS_ERR_COMM_ERROR = -1100, /* Communication Error */
\r
78 EPS_ERR_NOT_OPEN_IO = -1101, /* Could not open I/O port/channel */
\r
79 EPS_ERR_NOT_CLOSE_IO = -1102, /* Could not close I/O port/channel */
\r
80 EPS_ERR_2ND_OPEN_IO = -1103, /* Second Open I/O port */
\r
82 /*** epsInitDriver() Error */
\r
83 /*** -------------------------------------------------------------------------------*/
\r
84 EPS_ERR_INV_ARG_COMMMODE = -1200, /* Invalid argument "commMode" */
\r
85 EPS_ERR_INV_FNCP_NULL = -1201, /* Invalid function pointer structure */
\r
86 EPS_ERR_INV_FNCP_FINDCALLBACK = -1202, /* Invalid function pointer "findCallback" */
\r
87 EPS_ERR_INV_FNCP_MEMALLOC = -1203, /* Invalid function pointer "memAlloc" */
\r
88 EPS_ERR_INV_FNCP_MEMFREE = -1204, /* Invalid function pointer "memFree" */
\r
89 EPS_ERR_INV_FNCP_SLEEP = -1205, /* Invalid function pointer "sleep" */
\r
90 EPS_ERR_INV_FNCP_GETTIME = -1206, /* Invalid function pointer "getTime" and "lockSync" */
\r
92 EPS_ERR_INV_FNCP_OPENPORTAL = -1211, /* Invalid function pointer "openPortal" */
\r
93 EPS_ERR_INV_FNCP_CLOSEPORTAL = -1212, /* Invalid function pointer "closePortal" */
\r
94 EPS_ERR_INV_FNCP_READPORTAL = -1213, /* Invalid function pointer "readPortal" */
\r
95 EPS_ERR_INV_FNCP_WRITEPORTAL = -1214, /* Invalid function pointer "writePortal" */
\r
96 EPS_ERR_INV_FNCP_FINDFIRST = -1215, /* Invalid function pointer "findFirst" */
\r
97 EPS_ERR_INV_FNCP_FINDNEXT = -1216, /* Invalid function pointer "findNext" */
\r
98 EPS_ERR_INV_FNCP_FINDCLOSE = -1217, /* Invalid function pointer "findClose" */
\r
100 EPS_ERR_INV_FNCP_NETSOCKET = -1221, /* Invalid function pointer "socket" */
\r
101 EPS_ERR_INV_FNCP_NETCLOSE = -1222, /* Invalid function pointer "close" */
\r
102 EPS_ERR_INV_FNCP_NETCONNECT = -1223, /* Invalid function pointer "connect" */
\r
103 EPS_ERR_INV_FNCP_NETSHUTDOWN = -1224, /* Invalid function pointer "shutdown" */
\r
104 EPS_ERR_INV_FNCP_NETBIND = -1225, /* Invalid function pointer "bind" */
\r
105 EPS_ERR_INV_FNCP_NETLISTEN = -1226, /* Invalid function pointer "listen" */
\r
106 EPS_ERR_INV_FNCP_NETACCEPT = -1227, /* Invalid function pointer "accept" */
\r
107 EPS_ERR_INV_FNCP_NETSEND = -1228, /* Invalid function pointer "send" */
\r
108 EPS_ERR_INV_FNCP_NETSENDTO = -1229, /* Invalid function pointer "sendTo" */
\r
109 EPS_ERR_INV_FNCP_NETRECEIVE = -1230, /* Invalid function pointer "receive" */
\r
110 EPS_ERR_INV_FNCP_NETRECEIVEFROM = -1231, /* Invalid function pointer "receiveFrom" */
\r
111 EPS_ERR_INV_FNCP_NETGETSOCKNAME = -1232, /* Invalid function pointer "getsockname" */
\r
112 EPS_ERR_INV_FNCP_NETSETMULTITTL = -1233, /* Invalid function pointer "setMulticastMember" */
\r
113 EPS_ERR_INV_FNCP_NETSETBROADCAST = -1234, /* Invalid function pointer "setBroadcast" */
\r
115 /*** epsFindPrinter(), epsProbePrinter() Error */
\r
116 /*** -------------------------------------------------------------------------------*/
\r
117 EPS_ERR_PRINTER_NOT_FOUND = -1300, /* printer not found */
\r
118 EPS_ERR_INV_ARG_PROBEINFO = -1301, /* Invalid argument probe infomation */
\r
119 EPS_ERR_INV_ARG_UNK_METHOD = -1302, /* Invalid value "method" */
\r
120 EPS_ERR_INV_ARG_PRINTER_ID = -1303, /* Invalid format "identify" */
\r
121 EPS_ERR_INV_ARG_PRINTER_ADDR = -1304, /* Invalid format "address" */
\r
122 EPS_ERR_FIND_NOT_STARTED = -1305, /* Cancel find before start find */
\r
123 EPS_ERR_PRINTER_NOT_USEFUL = -1306, /* not useful printer found */
\r
125 /*** epsSetPrinter() Error */
\r
126 /*** -------------------------------------------------------------------------------*/
\r
127 EPS_ERR_INV_ARG_PRINTER = -1350, /* Invalid Argument "printer" */
\r
128 EPS_ERR_PRINTER_NOT_SET = -1351, /* Target printer is not specified */
\r
129 EPS_ERR_INV_PRINT_LANGUAGE = -1352, /* Invalid Argument "printer.language" */
\r
131 /*** Page Attribution Error (epsStartJob(), epsGetPrintableArea()) */
\r
132 /*** -------------------------------------------------------------------------------*/
\r
133 EPS_ERR_INV_MEDIA_SIZE = -1400, /* Invalid Media Size */
\r
134 EPS_ERR_INV_MEDIA_TYPE = -1401, /* Invalid Media Type */
\r
135 EPS_ERR_INV_BORDER_MODE = -1402, /* Invalid Border Mode */
\r
136 EPS_ERR_INV_PRINT_QUALITY = -1403, /* Invalid Print Quality */
\r
137 EPS_ERR_INV_COLOR_MODE = -1404, /* Invalid Color Mode */
\r
138 EPS_ERR_INV_INPUT_RESOLUTION = -1405, /* Invalid Input Resolution */
\r
139 EPS_ERR_INV_PRINT_DIRECTION = -1406, /* Invalid Print Direction */
\r
140 EPS_ERR_INV_COLOR_PLANE = -1407, /* Invalid Color Plane */
\r
141 EPS_ERR_INV_PALETTE_SIZE = -1408, /* Invalid Palette Size */
\r
142 EPS_ERR_INV_PALETTE_DATA = -1409, /* Invalid Palette Data */
\r
143 EPS_ERR_INV_BRIGHTNESS = -1410, /* Invalid Brightness */
\r
144 EPS_ERR_INV_CONTRAST = -1411, /* Invalid Contrast */
\r
145 EPS_ERR_INV_SATURATION = -1412, /* Invalid Saturation */
\r
146 /*EPS_ERR_INV_MEDIAOPTION = -1413, Invalid mediaOption */
\r
147 EPS_ERR_INV_TOP_MARGIN = -1420, /* Invalid Top Magirn */
\r
148 EPS_ERR_INV_LEFT_MARGIN = -1421, /* Invalid Left Margin */
\r
149 EPS_ERR_INV_BOTTOM_MARGIN = -1422, /* Invalid Bottom Margin */
\r
150 EPS_ERR_INV_RIGHT_MARGIN = -1423, /* Invalid Right Margin */
\r
151 EPS_ERR_MARGIN_OVER_PRINTABLE_WIDTH = -1424, /* Invalid Margin Setting (Width) */
\r
152 EPS_ERR_MARGIN_OVER_PRINTABLE_HEIGHT = -1425, /* Invalid Margin Setting (Height) */
\r
153 EPS_ERR_INV_PAPER_SOURCE = -1426, /* Invalid Paper source */
\r
154 EPS_ERR_INV_DUPLEX = -1427, /* Invalid duplex */
\r
155 EPS_ERR_INV_FEED_DIRECTION = -1428, /* Invalid feed direction */
\r
157 /*EPS_ERR_INV_APF_FLT = -1430, Invalid APF Filter */
\r
158 EPS_ERR_INV_APF_ACT = -1431, /* Invalid APF Auto Corretion */
\r
159 EPS_ERR_INV_APF_SHP = -1432, /* Invalid APF Sharpness */
\r
160 EPS_ERR_INV_APF_RDE = -1433, /* Invalid APF Redeye */
\r
161 EPS_ERR_INV_CD_INDIM = -1434, /* Invalid CD Inside Diameter */
\r
162 EPS_ERR_INV_CD_OUTDIM = -1435, /* Invalid CD Outside Diameter */
\r
163 EPS_ERR_INV_CMDTYPE = -1436, /* Invalid Command Type */
\r
165 EPS_ERR_INV_ARG_JOB_ATTRIB = -1450, /* Invalid argument "jobAttr" */
\r
166 EPS_ERR_INV_ARG_PAGE_ATTRIB = -1451, /* Invalid argument "thisPage" */
\r
168 /*** epsStartJob() / epsStartPage() Error */
\r
169 /*** -------------------------------------------------------------------------------*/
\r
170 /*EPS_ERR_CANNOT_PRINT = -1500,*//* Cannot start printing */
\r
172 /*** epsPrintBand() Error */
\r
173 /*** -------------------------------------------------------------------------------*/
\r
174 EPS_ERR_INV_ARG_DATA = -1600, /* Invalid argument "data" */
\r
175 EPS_ERR_INV_ARG_WIDTH_PIXELS = -1601, /* Invalid argument "widthPixels" */
\r
176 /* EPS_ERR_INV_ARG_BYTES_PER_LINE = -1602, Invalid argument "bytesPerLine" */
\r
177 EPS_ERR_INV_ARG_HEIGHT_PIXELS = -1603, /* Invalid argument "heightPixels" */
\r
178 EPS_ERR_INV_ARG_DATASIZE = -1610, /* Invalid argument "dataSize" */
\r
180 /*** epsCancelJob() Error */
\r
181 /*** -------------------------------------------------------------------------------*/
\r
182 EPS_ERR_CAN_NOT_RESET = -1650, /* Failed to reset printer */
\r
184 /*** epsGetStatus() / epsGetInkInfo() Error */
\r
185 /*** -------------------------------------------------------------------------------*/
\r
186 EPS_ERR_INV_ARG_STATUS = -1700, /* Invalid argument "status" */
\r
187 EPS_ERR_INV_ARG_INKINFO = -1710, /* Invalid argument "inkInfo" */
\r
189 /*** epsGetSupportedMedia() Error */
\r
190 /*** -------------------------------------------------------------------------------*/
\r
191 EPS_ERR_INV_ARG_SUPPORTED_MEDIA = -1750, /* Invalid Argument "supportedMedia" */
\r
193 /*** epsGetPrintableArea() Error */
\r
194 /*** -------------------------------------------------------------------------------*/
\r
195 EPS_ERR_INV_ARG_PRINTABLE_WIDTH = -1800, /* Invalid argument "printableWidth" */
\r
196 EPS_ERR_INV_ARG_PRINTABLE_HEIGHT = -1801, /* Invalid argument "printableHeight" */
\r
198 /*** epsSetAdditionalData() Error */
\r
199 /*** -------------------------------------------------------------------------------*/
\r
200 EPS_ERR_INV_ARG_ADDDATA = -2001, /* Invalid argument "data" */
\r
201 EPS_ERR_INV_ARG_QRSOURCE = -2002, /* Invalid argument "data.qrcode.source" */
\r
202 EPS_ERR_INV_ARG_QRXPOS = -2003, /* Invalid argument "data.qrcode.xPos" */
\r
203 EPS_ERR_INV_ARG_QRYPOS = -2004, /* Invalid argument "data.qrcode.yPos" */
\r
204 EPS_ERR_QRSOURCE_TOO_LAGE = -2005 /* source is too lage to convert QR code */
\r
208 /*--------------------------- Definition of Printer Status ---------------------------*/
\r
209 /*******************************************|********************************************/
\r
211 /*** Printer Status */
\r
212 /*** -------------------------------------------------------------------------------*/
\r
213 enum EPS_PRINTER_STATUS {
\r
214 EPS_PRNST_IDLE = 0, /* Idle (Enable Start Job) */
\r
215 EPS_PRNST_PRINTING , /* Printing */
\r
216 /* EPS_PRNST_OFFLINE , Offline */
\r
217 EPS_PRNST_BUSY , /* Busy (Disable Start Job) */
\r
218 EPS_PRNST_CANCELLING , /* Cancellation processing */
\r
219 EPS_PRNST_ERROR /* Printer has an error */
\r
222 /*** Printer Error */
\r
223 /*** -------------------------------------------------------------------------------*/
\r
224 enum EPS_PRINTER_ERROR {
\r
225 EPS_PRNERR_NOERROR = 0,
\r
226 EPS_PRNERR_GENERAL ,
\r
228 EPS_PRNERR_INTERFACE ,
\r
229 EPS_PRNERR_COVEROPEN ,
\r
230 /* EPS_PRNERR_LEVERPOSITION ,*/ /* Not supported by 2006 Model */
\r
231 EPS_PRNERR_PAPERJAM ,
\r
232 EPS_PRNERR_INKOUT ,
\r
233 EPS_PRNERR_PAPEROUT ,
\r
234 /* EPS_PRNERR_INITIALIZESETTING ,*/ /* Not supported by 2006 Model */
\r
235 /* EPS_PRNERR_UNKNOWN ,*/ /* Not supported by 2006 Model */
\r
236 /* EPS_PRNERR_PAPERCHANGE_UNCOMP ,*/ /* Not supported by 2006 Model */
\r
237 /* EPS_PRNERR_PAPERSIZE ,*/ /* Not supported by 2006 Model */
\r
238 /* EPS_PRNERR_RIBBONJAM ,*/ /* Not supported by 2006 Model */
\r
239 EPS_PRNERR_SIZE_TYPE_PATH ,
\r
240 /* EPS_PRNERR_PAPERTHICKLEVER ,*/ /* Not supported by 2006 Model */
\r
241 /* EPS_PRNERR_PAPERFEED ,*/ /* Not supported by 2006 Model */
\r
242 /* EPS_PRNERR_SIMMCOPY ,*/ /* Not supported by 2006 Model */
\r
243 EPS_PRNERR_SERVICEREQ , /* EPS_PRNERR_INKOVERFLOW1 */
\r
244 /* EPS_PRNERR_WAITTEAROFFRETURN ,*/ /* Not supported by 2006 Model */
\r
245 EPS_PRNERR_DOUBLEFEED ,
\r
246 /* EPS_PRNERR_HEADHOT ,*/ /* Not supported by 2006 Model */
\r
247 /* EPS_PRNERR_PAPERCUTMIS ,*/ /* Not supported by 2006 Model */
\r
248 /* EPS_PRNERR_HOLDLEVERRELEASE ,*/ /* Not supported by 2006 Model */
\r
249 /* EPS_PRNERR_NOT_CLEANING ,*/ /* Not supported by 2006 Model */
\r
250 /* EPS_PRNERR_PAPERCONFIG ,*/ /* Not supported by 2006 Model */
\r
251 /* EPS_PRNERR_PAPERSLANT ,*/ /* Not supported by 2006 Model */
\r
252 /* EPS_PRNERR_CLEANINGNUMOVER ,*/ /* Not supported by 2006 Model */
\r
253 EPS_PRNERR_INKCOVEROPEN ,
\r
254 /* EPS_PRNERR_LFP_INKCARTRIDGE ,*/ /* Not supported by 2006 Model */
\r
255 /* EPS_PRNERR_CUTTER ,*/ /* Not supported by 2006 Model */
\r
256 /* EPS_PRNERR_CUTTERJAM ,*/ /* Not supported by 2006 Model */
\r
257 /* EPS_PRNERR_INKCOLOR ,*/ /* Not supported by 2006 Model */
\r
258 /* EPS_PRNERR_CUTTERCOVEROPEN ,*/ /* Not supported by 2006 Model */
\r
259 /* EPS_PRNERR_LFP_INKLEVERRELEASE ,*/ /* Not supported by 2006 Model */
\r
260 /* EPS_PRNERR_LFP_NOMAINTENANCETANK1 ,*/ /* Not supported by 2006 Model */
\r
261 /* EPS_PRNERR_CARTRIDGECOMBINATION ,*/ /* Not supported by 2006 Model */
\r
262 /* EPS_PRNERR_LFP_COMMAND ,*/ /* Not supported by 2006 Model */
\r
263 /* EPS_PRNERR_LEARCOVEROPEN ,*/ /* Not supported by 2006 Model */
\r
264 /* EPS_PRNERR_MULTICENSORGAIN ,*/ /* Not supported by 2006 Model */
\r
265 /* EPS_PRNERR_NOT_AUTOADJUST ,*/ /* Not supported by 2006 Model */
\r
266 /* EPS_PRNERR_FAILCLEANING ,*/ /* Not supported by 2006 Model */
\r
267 EPS_PRNERR_NOTRAY ,
\r
268 EPS_PRNERR_CARDLOADING ,
\r
269 EPS_PRNERR_CARTRIDGEOVERFLOW ,
\r
270 /* EPS_PRNERR_LFP_NOMAINTENANCETANK2 ,*/ /* Not supported by 2006 Model */
\r
271 /* EPS_PRNERR_INKOVERFLOW2 ,*/ /* Not supported by 2006 Model */
\r
272 EPS_PRNERR_BATTERYVOLTAGE ,
\r
273 EPS_PRNERR_BATTERYTEMPERATURE ,
\r
274 EPS_PRNERR_BATTERYEMPTY ,
\r
275 EPS_PRNERR_SHUTOFF ,
\r
276 EPS_PRNERR_NOT_INITIALFILL ,
\r
277 EPS_PRNERR_PRINTPACKEND ,
\r
278 /* EPS_PRNERR_ABNORMALHEAT ,*/ /* Not supported by 2006 Model */
\r
279 EPS_PRNERR_SCANNEROPEN ,
\r
280 EPS_PRNERR_CDRGUIDEOPEN ,
\r
282 /* append for 2008 Model */
\r
283 EPS_PRNERR_CDDVDCONFIG ,
\r
284 EPS_PRNERR_CDREXIST_MAINTE ,
\r
287 EPS_PRNERR_BUSY = 100,
\r
288 EPS_PRNERR_FACTORY ,
\r
289 /* Communication Error */
\r
292 EPS_PRNERR_CEMPTY ,
\r
294 /* Printer Condition */
\r
295 EPS_PRNERR_TRAYCLOSE ,
\r
296 EPS_PRNERR_CDGUIDECLOSE , /* CDR guide close */
\r
297 /* EPS_PRNERR_OVERHEAT OVERHEAT is not an error */
\r
298 EPS_PRNERR_JPG_LIMIT , /* Jpeg print data size limit */
\r
299 EPS_PRNERR_DISABEL_CLEANING /* can not start Head Cleaning */
\r
303 /*** Ink Cartridge Error */
\r
304 /*** -------------------------------------------------------------------------------*/
\r
305 #define EPS_INK_NOTPRESENT (-1)
\r
306 #define EPS_INK_FAIL (-2)
\r
307 #define EPS_INK_NOTAVAIL (-3)
\r
308 #define EPS_INK_NOREAD (-4)
\r
310 /*** Notifification Reply Values */
\r
311 /*** -------------------------------------------------------------------------------*/
\r
312 #define EPS_CONTINUE_POSSIBLE 1
\r
313 #define EPS_CONTINUE_NOT_POSSIBLE 0
\r
315 /*** Notifification Reply Values */
\r
316 /*** -------------------------------------------------------------------------------*/
\r
317 #define EPS_USER_CONTINUE -20
\r
318 #define EPS_USER_CANCEL -30
\r
324 #endif /* def __EPSON_ESCPR_ERR_H__ */
\r
326 /*________________________________ epson-escpr-err.h ________________________________*/
\r
328 /*34567890123456789012345678901234567890123456789012345678901234567890123456789012345678*/
\r
329 /* 1 2 3 4 5 6 7 8 */
\r
330 /*******************************************|********************************************/
\r
331 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%|%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
\r
332 /***** End of File *** End of File *** End of File *** End of File *** End of File ******/
\r
333 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%|%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
\r