includes: Fix alignment for 64-bits
[wine/wine64.git] / include / twain.h
blob13bc406b2710f52e1a8b2b028a9646775cac938f
1 /* ======================================================================== *\
3 Copyright (C) 1991, 1992 TWAIN Working Group: Aldus, Caere, Eastman-Kodak,
4 Hewlett-Packard and Logitech Corporations. All rights reserved.
6 Copyright (C) 1997 TWAIN Working Group: Bell+Howell, Canon, DocuMagix,
7 Fujitsu, Genoa Technology, Hewlett-Packard, Kofax Imaging Products, and
8 Ricoh Corporation. All rights reserved.
10 Copyright (C) 1998 TWAIN Working Group: Adobe Systems Incorporated,
11 Canon Information Systems, Eastman Kodak Company,
12 Fujitsu Computer Products of America, Genoa Technology,
13 Hewlett-Packard Company, Intel Corporation, Kofax Image Products,
14 JFL Peripheral Solutions Inc., Ricoh Corporation, and Xerox Corporation.
15 All rights reserved.
17 TWAIN.h - This is the definitive include file for applications and
18 data sources written to the TWAIN specification.
19 It defines constants, data structures, messages etc.
20 for the public interface to TWAIN.
22 Revision History:
23 version 1.0, March 6, 1992. TWAIN 1.0.
24 version 1.1, January 1993. Tech Notes 1.1
25 version 1.5, June 1993. Specification Update 1.5
26 Change DC to TW
27 Change filename from DC.H to TWAIN.H
28 version 1.5, July 1993. Remove spaces from country identifiers
30 version 1.7, July 1997 Added Capabilities and data structure for
31 document imaging and digital cameras.
32 KHL.
33 version 1.7, July 1997 Inserted Borland compatible structure packing
34 directives provided by Mentor. JMH
35 version 1.7, Aug 1997 Expanded file tabs to spaces.
36 NOTE: future authors should be sure to have
37 their editors set to automatically expand tabs
38 to spaces (original tab setting was 4 spaces).
39 version 1.7, Sept 1997 Added job control values
40 Added return codes
41 version 1.7, Sept 1997 changed definition of pRGBRESPONSE to
42 pTW_RGBRESPONSE
43 version 1.7 Aug 1998 Added missing TWEI_BARCODEROTATION values
44 TWBCOR_ types JMH
45 version 1.8 August 1998 Added new types and definitions required
46 for 1.8 Specification JMH
47 version 1.8 January 1999 Changed search mode from SRCH_ to TWBD_ as
48 in 1.8 Specification, added TWBT_MAXICODE JMH
49 version 1.8 January 1999 Removed undocumented duplicate AUTO<cap> JMH
50 \* ======================================================================== */
52 #ifndef TWAIN
53 #define TWAIN
55 #include <stdarg.h>
57 #include "windef.h"
58 #include "winbase.h"
60 /* The Twain structures must be packed on 2 byte alignment */
61 #include "pshpack2.h"
63 #undef FAR
64 #define FAR
65 #define huge
66 #define WIN32
67 #define _WIN32
68 #undef __declspec
69 #define __declspec(spec)
71 /****************************************************************************
72 * TWAIN Version *
73 ****************************************************************************/
74 #define TWON_PROTOCOLMINOR 8 /* Changed for Version 1.8 */
75 #define TWON_PROTOCOLMAJOR 1
77 /****************************************************************************
78 * Platform Dependent Definitions and Typedefs *
79 ****************************************************************************/
81 /* Define one of the following, depending on the platform */
82 /* #define _MAC_ */
83 /* #define _UNIX_ */
84 #define _MSWIN_
86 #ifdef _MSWIN_
87 typedef HANDLE TW_HANDLE;
88 typedef LPVOID TW_MEMREF;
90 /* SDH - 05/05/95 - TWUNK */
91 /* For common code between 16 and 32 bits. */
92 # ifdef WIN32
93 # define TW_HUGE
94 # else /* WIN32 */
95 # define TW_HUGE huge
96 # endif /* WIN32 */
97 typedef BYTE TW_HUGE * HPBYTE;
98 typedef void TW_HUGE * HPVOID;
99 #endif /* _MSWIN_ */
101 #ifdef _MAC_
102 #define PASCAL pascal
103 #define FAR
104 typedef Handle TW_HANDLE;
105 typedef char *TW_MEMREF;
106 #endif /* _MAC_ */
108 #ifdef _UNIX_
109 /* #define PASCAL pascal */
110 #define FAR
111 typedef unsigned char *TW_HANDLE;
112 typedef unsigned char *TW_MEMREF;
113 #endif /* _UNIX_ */
115 /****************************************************************************
116 * Type Definitions *
117 ****************************************************************************/
119 /* String types. These include room for the strings and a NULL char, *
120 * or, on the Mac, a length byte followed by the string. *
121 * TW_STR255 must hold less than 256 chars so length fits in first byte. */
122 typedef char TW_STR32[34], FAR *pTW_STR32;
123 typedef char TW_STR64[66], FAR *pTW_STR64;
124 typedef char TW_STR128[130], FAR *pTW_STR128;
125 typedef char TW_STR255[256], FAR *pTW_STR255;
127 /* Numeric types. */
128 typedef char TW_INT8, FAR *pTW_INT8;
129 typedef short TW_INT16, FAR *pTW_INT16;
130 typedef long TW_INT32, FAR *pTW_INT32;
131 typedef unsigned char TW_UINT8, FAR *pTW_UINT8;
132 typedef unsigned short TW_UINT16, FAR *pTW_UINT16;
133 typedef unsigned long TW_UINT32, FAR *pTW_UINT32;
134 typedef unsigned short TW_BOOL, FAR *pTW_BOOL;
136 /* Fixed point structure type. */
137 typedef struct {
138 TW_INT16 Whole; /* maintains the sign */
139 TW_UINT16 Frac;
140 } TW_FIX32, FAR *pTW_FIX32;
142 /****************************************************************************
143 * Structure Definitions *
144 ****************************************************************************/
146 /* No DAT needed. */
147 typedef struct {
148 TW_FIX32 X;
149 TW_FIX32 Y;
150 TW_FIX32 Z;
151 } TW_CIEPOINT, FAR * pTW_CIEPOINT;
153 /* No DAT needed. */
154 typedef struct {
155 TW_FIX32 StartIn;
156 TW_FIX32 BreakIn;
157 TW_FIX32 EndIn;
158 TW_FIX32 StartOut;
159 TW_FIX32 BreakOut;
160 TW_FIX32 EndOut;
161 TW_FIX32 Gamma;
162 TW_FIX32 SampleCount; /* if =0 use the gamma */
163 } TW_DECODEFUNCTION, FAR * pTW_DECODEFUNCTION;
165 /* No DAT needed. */
166 typedef struct {
167 TW_UINT8 Index; /* Value used to index into the color table. */
168 TW_UINT8 Channel1; /* First tri-stimulus value (e.g Red) */
169 TW_UINT8 Channel2; /* Second tri-stimulus value (e.g Green) */
170 TW_UINT8 Channel3; /* Third tri-stimulus value (e.g Blue) */
171 } TW_ELEMENT8, FAR * pTW_ELEMENT8;
173 /* No DAT. Defines a frame rectangle in ICAP_UNITS coordinates. */
174 typedef struct {
175 TW_FIX32 Left;
176 TW_FIX32 Top;
177 TW_FIX32 Right;
178 TW_FIX32 Bottom;
179 } TW_FRAME, FAR * pTW_FRAME;
181 /* No DAT needed. Used to manage memory buffers. */
182 typedef struct {
183 TW_UINT32 Flags; /* Any combination of the TWMF_ constants. */
184 TW_UINT32 Length; /* Number of bytes stored in buffer TheMem. */
185 TW_MEMREF TheMem; /* Pointer or handle to the allocated memory buffer. */
186 } TW_MEMORY, FAR * pTW_MEMORY;
188 /* No DAT needed. */
189 typedef struct {
190 TW_DECODEFUNCTION Decode[3];
191 TW_FIX32 Mix[3][3];
192 } TW_TRANSFORMSTAGE, FAR * pTW_TRANSFORMSTAGE;
194 /* No DAT needed. Describes version of software currently running. */
195 typedef struct {
196 TW_UINT16 MajorNum; /* Major revision number of the software. */
197 TW_UINT16 MinorNum; /* Incremental revision number of the software. */
198 TW_UINT16 Language; /* e.g. TWLG_SWISSFRENCH */
199 TW_UINT16 Country; /* e.g. TWCY_SWITZERLAND */
200 TW_STR32 Info; /* e.g. "1.0b3 Beta release" */
201 } TW_VERSION, FAR * pTW_VERSION;
203 /* TWON_ARRAY. Container for array of values (a simplified TW_ENUMERATION) */
204 typedef struct {
205 TW_UINT16 ItemType;
206 TW_UINT32 NumItems; /* How many items in ItemList */
207 TW_UINT8 ItemList[1]; /* Array of ItemType values starts here */
208 } TW_ARRAY, FAR * pTW_ARRAY;
210 /* TWON_ENUMERATION. Container for a collection of values. */
211 typedef struct {
212 TW_UINT16 ItemType;
213 TW_UINT32 NumItems; /* How many items in ItemList */
214 TW_UINT32 CurrentIndex; /* Current value is in ItemList[CurrentIndex] */
215 TW_UINT32 DefaultIndex; /* Powerup value is in ItemList[DefaultIndex] */
216 TW_UINT8 ItemList[1]; /* Array of ItemType values starts here */
217 } TW_ENUMERATION, FAR * pTW_ENUMERATION;
219 /* TWON_ONEVALUE. Container for one value. */
220 typedef struct {
221 TW_UINT16 ItemType;
222 TW_UINT32 Item;
223 } TW_ONEVALUE, FAR * pTW_ONEVALUE;
225 /* TWON_RANGE. Container for a range of values. */
226 typedef struct {
227 TW_UINT16 ItemType;
228 TW_UINT32 MinValue; /* Starting value in the range. */
229 TW_UINT32 MaxValue; /* Final value in the range. */
230 TW_UINT32 StepSize; /* Increment from MinValue to MaxValue. */
231 TW_UINT32 DefaultValue; /* Power-up value. */
232 TW_UINT32 CurrentValue; /* The value that is currently in effect. */
233 } TW_RANGE, FAR * pTW_RANGE;
235 /* DAT_CAPABILITY. Used by application to get/set capability from/in a data source. */
236 typedef struct {
237 TW_UINT16 Cap; /* id of capability to set or get, e.g. CAP_BRIGHTNESS */
238 TW_UINT16 ConType; /* TWON_ONEVALUE, _RANGE, _ENUMERATION or _ARRAY */
239 TW_HANDLE hContainer; /* Handle to container of type Dat */
240 } TW_CAPABILITY, FAR * pTW_CAPABILITY;
242 /* DAT_CIECOLOR. */
243 typedef struct {
244 TW_UINT16 ColorSpace;
245 TW_INT16 LowEndian;
246 TW_INT16 DeviceDependent;
247 TW_INT32 VersionNumber;
248 TW_TRANSFORMSTAGE StageABC;
249 TW_TRANSFORMSTAGE StageLMN;
250 TW_CIEPOINT WhitePoint;
251 TW_CIEPOINT BlackPoint;
252 TW_CIEPOINT WhitePaper;
253 TW_CIEPOINT BlackInk;
254 TW_FIX32 Samples[1];
255 } TW_CIECOLOR, FAR * pTW_CIECOLOR;
257 /* DAT_EVENT. For passing events down from the application to the DS. */
258 typedef struct {
259 TW_MEMREF pEvent; /* Windows pMSG or Mac pEvent. */
260 TW_UINT16 TWMessage; /* TW msg from data source, e.g. MSG_XFERREADY */
261 } TW_EVENT, FAR * pTW_EVENT;
263 /* DAT_GRAYRESPONSE */
264 typedef struct {
265 TW_ELEMENT8 Response[1];
266 } TW_GRAYRESPONSE, FAR * pTW_GRAYRESPONSE;
268 /* DAT_IDENTITY. Identifies the program/library/code resource. */
269 typedef struct {
270 TW_UINT32 Id; /* Unique number. In Windows, application hWnd */
271 TW_VERSION Version; /* Identifies the piece of code */
272 TW_UINT16 ProtocolMajor; /* Application and DS must set to TWON_PROTOCOLMAJOR */
273 TW_UINT16 ProtocolMinor; /* Application and DS must set to TWON_PROTOCOLMINOR */
274 TW_UINT32 SupportedGroups; /* Bit field OR combination of DG_ constants */
275 TW_STR32 Manufacturer; /* Manufacturer name, e.g. "Hewlett-Packard" */
276 TW_STR32 ProductFamily; /* Product family name, e.g. "ScanJet" */
277 TW_STR32 ProductName; /* Product name, e.g. "ScanJet Plus" */
278 } TW_IDENTITY, FAR * pTW_IDENTITY;
280 /* DAT_IMAGEINFO. Application gets detailed image info from DS with this. */
281 typedef struct {
282 TW_FIX32 XResolution; /* Resolution in the horizontal */
283 TW_FIX32 YResolution; /* Resolution in the vertical */
284 TW_INT32 ImageWidth; /* Columns in the image, -1 if unknown by DS*/
285 TW_INT32 ImageLength; /* Rows in the image, -1 if unknown by DS */
286 TW_INT16 SamplesPerPixel; /* Number of samples per pixel, 3 for RGB */
287 TW_INT16 BitsPerSample[8]; /* Number of bits for each sample */
288 TW_INT16 BitsPerPixel; /* Number of bits for each padded pixel */
289 TW_BOOL Planar; /* True if Planar, False if chunky */
290 TW_INT16 PixelType; /* How to interp data; photo interp (TWPT_) */
291 TW_UINT16 Compression; /* How the data is compressed (TWCP_xxxx) */
292 } TW_IMAGEINFO, FAR * pTW_IMAGEINFO;
294 /* DAT_IMAGELAYOUT. Provides image layout information in current units. */
295 typedef struct {
296 TW_FRAME Frame; /* Frame coords within larger document */
297 TW_UINT32 DocumentNumber;
298 TW_UINT32 PageNumber; /* Reset when you go to next document */
299 TW_UINT32 FrameNumber; /* Reset when you go to next page */
300 } TW_IMAGELAYOUT, FAR * pTW_IMAGELAYOUT;
302 /* DAT_IMAGEMEMXFER. Used to pass image data (e.g. in strips) from DS to application.*/
303 typedef struct {
304 TW_UINT16 Compression; /* How the data is compressed */
305 TW_UINT32 BytesPerRow; /* Number of bytes in a row of data */
306 TW_UINT32 Columns; /* How many columns */
307 TW_UINT32 Rows; /* How many rows */
308 TW_UINT32 XOffset; /* How far from the side of the image */
309 TW_UINT32 YOffset; /* How far from the top of the image */
310 TW_UINT32 BytesWritten; /* How many bytes written in Memory */
311 TW_MEMORY Memory; /* Mem struct used to pass actual image data */
312 } TW_IMAGEMEMXFER, FAR * pTW_IMAGEMEMXFER;
314 /* Changed in 1.1: QuantTable, HuffmanDC, HuffmanAC TW_MEMREF -> TW_MEMORY */
315 /* DAT_JPEGCOMPRESSION. Based on JPEG Draft International Std, ver 10918-1. */
316 typedef struct {
317 TW_UINT16 ColorSpace; /* One of the TWPT_xxxx values */
318 TW_UINT32 SubSampling; /* Two word "array" for subsampling values */
319 TW_UINT16 NumComponents; /* Number of color components in image */
320 TW_UINT16 RestartFrequency; /* Frequency of restart marker codes in MDU's */
321 TW_UINT16 QuantMap[4]; /* Mapping of components to QuantTables */
322 TW_MEMORY QuantTable[4]; /* Quantization tables */
323 TW_UINT16 HuffmanMap[4]; /* Mapping of components to Huffman tables */
324 TW_MEMORY HuffmanDC[2]; /* DC Huffman tables */
325 TW_MEMORY HuffmanAC[2]; /* AC Huffman tables */
326 } TW_JPEGCOMPRESSION, FAR * pTW_JPEGCOMPRESSION;
328 /* DAT_PALETTE8. Color palette when TWPT_PALETTE pixels xfer'd in mem buf. */
329 typedef struct {
330 TW_UINT16 NumColors; /* Number of colors in the color table. */
331 TW_UINT16 PaletteType; /* TWPA_xxxx, specifies type of palette. */
332 TW_ELEMENT8 Colors[256]; /* Array of palette values starts here. */
333 } TW_PALETTE8, FAR * pTW_PALETTE8;
335 /* DAT_PENDINGXFERS. Used with MSG_ENDXFER to indicate additional data. */
336 typedef struct {
337 TW_UINT16 Count;
338 union {
339 TW_UINT32 EOJ;
340 TW_UINT32 Reserved;
341 } u;
342 } TW_PENDINGXFERS, FAR *pTW_PENDINGXFERS;
344 /* DAT_RGBRESPONSE */
345 typedef struct {
346 TW_ELEMENT8 Response[1];
347 } TW_RGBRESPONSE, FAR * pTW_RGBRESPONSE;
349 /* DAT_SETUPFILEXFER. Sets up DS to application data transfer via a file. */
350 typedef struct {
351 TW_STR255 FileName;
352 TW_UINT16 Format; /* Any TWFF_ constant */
353 TW_INT16 VRefNum; /* Used for Mac only */
354 } TW_SETUPFILEXFER, FAR * pTW_SETUPFILEXFER;
356 /* DAT_SETUPMEMXFER. Sets up DS to application data transfer via a memory buffer. */
357 typedef struct {
358 TW_UINT32 MinBufSize;
359 TW_UINT32 MaxBufSize;
360 TW_UINT32 Preferred;
361 } TW_SETUPMEMXFER, FAR * pTW_SETUPMEMXFER;
363 /* DAT_STATUS. Application gets detailed status info from a data source with this. */
364 typedef struct {
365 TW_UINT16 ConditionCode; /* Any TWCC_ constant */
366 TW_UINT16 Reserved; /* Future expansion space */
367 } TW_STATUS, FAR * pTW_STATUS;
369 /* DAT_USERINTERFACE. Coordinates UI between application and data source. */
370 typedef struct {
371 TW_BOOL ShowUI; /* TRUE if DS should bring up its UI */
372 TW_BOOL ModalUI; /* For Mac only - true if the DS's UI is modal */
373 TW_HANDLE hParent; /* For windows only - Application window handle */
374 } TW_USERINTERFACE, FAR * pTW_USERINTERFACE;
376 /* SDH - 03/21/95 - TWUNK */
377 /* DAT_TWUNKIDENTITY. Provides DS identity and 'other' information necessary */
378 /* across thunk link. */
379 typedef struct {
380 TW_IDENTITY identity; /* Identity of data source. */
381 TW_STR255 dsPath; /* Full path and file name of data source. */
382 } TW_TWUNKIDENTITY, FAR * pTW_TWUNKIDENTITY;
384 /* SDH - 03/21/95 - TWUNK */
385 /* Provides DS_Entry parameters over thunk link. */
386 typedef struct
388 TW_INT8 destFlag; /* TRUE if dest is not NULL */
389 TW_IDENTITY dest; /* Identity of data source (if used) */
390 TW_INT32 dataGroup; /* DSM_Entry dataGroup parameter */
391 TW_INT16 dataArgType; /* DSM_Entry dataArgType parameter */
392 TW_INT16 message; /* DSM_Entry message parameter */
393 TW_INT32 pDataSize; /* Size of pData (0 if NULL) */
394 /* TW_MEMREF pData; */ /* Based on implementation specifics, a */
395 /* pData parameter makes no sense in this */
396 /* structure, but data (if provided) will be*/
397 /* appended in the data block. */
398 } TW_TWUNKDSENTRYPARAMS, FAR * pTW_TWUNKDSENTRYPARAMS;
400 /* SDH - 03/21/95 - TWUNK */
401 /* Provides DS_Entry results over thunk link. */
402 typedef struct
404 TW_UINT16 returnCode; /* Thunker DsEntry return code. */
405 TW_UINT16 conditionCode; /* Thunker DsEntry condition code. */
406 TW_INT32 pDataSize; /* Size of pData (0 if NULL) */
407 /* TW_MEMREF pData; */ /* Based on implementation specifics, a */
408 /* pData parameter makes no sense in this */
409 /* structure, but data (if provided) will be*/
410 /* appended in the data block. */
411 } TW_TWUNKDSENTRYRETURN, FAR * pTW_TWUNKDSENTRYRETURN;
413 /* WJD - 950818 */
414 /* Added for 1.6 Specification */
415 /* TWAIN 1.6 CAP_SUPPORTEDCAPSEXT structure */
416 typedef struct
418 TW_UINT16 Cap; /* Which CAP/ICAP info is relevant to */
419 TW_UINT16 Properties; /* Messages this CAP/ICAP supports */
420 } TW_CAPEXT, FAR * pTW_CAPEXT;
422 /* ----------------------------------------------------------------------- *\
424 Version 1.7: Added Following data structure for Document Imaging
425 July 1997 Enhancement.
426 KHL TW_CUSTOMDSDATA -- For Saving and Restoring Source's
427 state.
428 TW_INFO -- Each attribute for extended image
429 information.
430 TW_EXTIMAGEINFO -- Extended image information structure.
432 \* ----------------------------------------------------------------------- */
434 typedef struct {
435 TW_UINT32 InfoLength; /* Length of Information in bytes. */
436 TW_HANDLE hData; /* Place holder for data, DS Allocates */
437 }TW_CUSTOMDSDATA, FAR *pTW_CUSTOMDSDATA;
439 typedef struct {
440 TW_UINT16 InfoID;
441 TW_UINT16 ItemType;
442 TW_UINT16 NumItems;
443 TW_UINT16 CondCode;
444 TW_UINT32 Item;
445 }TW_INFO, FAR* pTW_INFO;
447 typedef struct {
448 TW_UINT32 NumInfos;
449 TW_INFO Info[1];
450 }TW_EXTIMAGEINFO, FAR* pTW_EXTIMAGEINFO;
452 /* Added 1.8 */
454 /* DAT_AUDIOINFO, information about audio data */
455 typedef struct {
456 TW_STR255 Name; /* name of audio data */
457 TW_UINT32 Reserved; /* reserved space */
458 } TW_AUDIOINFO, FAR * pTW_AUDIOINFO;
460 /* DAT_DEVICEEVENT, information about events */
461 typedef struct {
462 TW_UINT32 Event; /* One of the TWDE_xxxx values. */
463 TW_STR255 DeviceName; /* The name of the device that generated the event */
464 TW_UINT32 BatteryMinutes; /* Battery Minutes Remaining */
465 TW_INT16 BatteryPercentage; /* Battery Percentage Remaining */
466 TW_INT32 PowerSupply; /* Power Supply */
467 TW_FIX32 XResolution; /* Resolution */
468 TW_FIX32 YResolution; /* Resolution */
469 TW_UINT32 FlashUsed2; /* Flash Used2 */
470 TW_UINT32 AutomaticCapture; /* Automatic Capture */
471 TW_UINT32 TimeBeforeFirstCapture; /* Automatic Capture */
472 TW_UINT32 TimeBetweenCaptures; /* Automatic Capture */
473 } TW_DEVICEEVENT, FAR * pTW_DEVICEEVENT;
475 /* DAT_FILESYSTEM, information about TWAIN file system */
476 typedef struct {
477 /* DG_CONTROL / DAT_FILESYSTEM / MSG_xxxx fields */
478 TW_STR255 InputName; /* The name of the input or source file */
479 TW_STR255 OutputName; /* The result of an operation or the name of a destination file */
480 TW_MEMREF Context; /* Source specific data used to remember state information */
481 /* DG_CONTROL / DAT_FILESYSTEM / MSG_DELETE field */
482 int Recursive; /* recursively delete all sub-directories */
483 /* DG_CONTROL / DAT_FILESYSTEM / MSG_GETINFO fields */
484 TW_INT32 FileType; /* One of the TWFT_xxxx values */
485 TW_UINT32 Size; /* Size of current FileType */
486 TW_STR32 CreateTimeDate; /* creation date of the file */
487 TW_STR32 ModifiedTimeDate; /* last date the file was modified */
488 TW_UINT32 FreeSpace; /* bytes of free space on the current device */
489 TW_INT32 NewImageSize; /* estimate of the amount of space a new image would take up */
490 TW_UINT32 NumberOfFiles; /* number of files, depends on FileType */
491 TW_UINT32 NumberOfSnippets; /**/
492 char Reserved[512]; /**/
493 } TW_FILESYSTEM, FAR * pTW_FILESYSTEM;
495 /* DAT_PASSTHRU, device dependent data to pass through Data Source */
496 typedef struct {
497 TW_MEMREF pCommand; /* Pointer to Command buffer */
498 TW_UINT32 CommandBytes; /* Number of bytes in Command buffer */
499 TW_INT32 Direction; /* One of the TWDR_xxxx values. Defines the direction of data flow */
500 TW_MEMREF pData; /* Pointer to Data buffer */
501 TW_UINT32 DataBytes; /* Number of bytes in Data buffer */
502 TW_UINT32 DataBytesXfered; /* Number of bytes successfully transferred */
503 } TW_PASSTHRU, FAR * pTW_PASSTHRU;
505 /* DAT_SETUPAUDIOFILEXFER, information required to setup an audio file transfer */
506 typedef struct {
507 TW_STR255 FileName; /* full path target file */
508 TW_UINT16 Format; /* one of TWAF_xxxx */
509 TW_INT16 VRefNum;
510 } TW_SETUPAUDIOFILEXFER, FAR * pTW_SETUPAUDIOFILEXFER;
512 /****************************************************************************
513 * Generic Constants *
514 ****************************************************************************/
516 #define TWON_ARRAY 3 /* indicates TW_ARRAY container */
517 #define TWON_ENUMERATION 4 /* indicates TW_ENUMERATION container */
518 #define TWON_ONEVALUE 5 /* indicates TW_ONEVALUE container */
519 #define TWON_RANGE 6 /* indicates TW_RANGE container */
521 #define TWON_ICONID 962 /* res Id of icon used in USERSELECT lbox */
522 #define TWON_DSMID 461 /* res Id of the DSM version num resource */
523 #define TWON_DSMCODEID 63 /* res Id of the Mac SM Code resource */
525 #define TWON_DONTCARE8 0xff
526 #define TWON_DONTCARE16 0xffff
527 #define TWON_DONTCARE32 0xffffffff
529 /* Flags used in TW_MEMORY structure. */
530 #define TWMF_APPOWNS 0x1
531 #define TWMF_DSMOWNS 0x2
532 #define TWMF_DSOWNS 0x4
533 #define TWMF_POINTER 0x8
534 #define TWMF_HANDLE 0x10
536 /* Palette types for TW_PALETTE8 */
537 #define TWPA_RGB 0
538 #define TWPA_GRAY 1
539 #define TWPA_CMY 2
541 /* There are four containers used for capabilities negotiation:
542 * TWON_ONEVALUE, TWON_RANGE, TWON_ENUMERATION, TWON_ARRAY
543 * In each container structure ItemType can be TWTY_INT8, TWTY_INT16, etc.
544 * The kind of data stored in the container can be determined by doing
545 * DCItemSize[ItemType] where the following is defined in TWAIN glue code:
546 * DCItemSize[]= { sizeof(TW_INT8),
547 * sizeof(TW_INT16),
548 * etc.
549 * sizeof(TW_UINT32) };
553 #define TWTY_INT8 0x0000 /* Means Item is a TW_INT8 */
554 #define TWTY_INT16 0x0001 /* Means Item is a TW_INT16 */
555 #define TWTY_INT32 0x0002 /* Means Item is a TW_INT32 */
557 #define TWTY_UINT8 0x0003 /* Means Item is a TW_UINT8 */
558 #define TWTY_UINT16 0x0004 /* Means Item is a TW_UINT16 */
559 #define TWTY_UINT32 0x0005 /* Means Item is a TW_UINT32 */
561 #define TWTY_BOOL 0x0006 /* Means Item is a TW_BOOL */
563 #define TWTY_FIX32 0x0007 /* Means Item is a TW_FIX32 */
565 #define TWTY_FRAME 0x0008 /* Means Item is a TW_FRAME */
567 #define TWTY_STR32 0x0009 /* Means Item is a TW_STR32 */
568 #define TWTY_STR64 0x000a /* Means Item is a TW_STR64 */
569 #define TWTY_STR128 0x000b /* Means Item is a TW_STR128 */
570 #define TWTY_STR255 0x000c /* Means Item is a TW_STR255 */
572 /****************************************************************************
573 * Capability Constants *
574 ****************************************************************************/
576 /* ICAP_BITORDER values (BO_ means Bit Order) */
577 #define TWBO_LSBFIRST 0
578 #define TWBO_MSBFIRST 1
580 /* ICAP_COMPRESSION values (CP_ means ComPression ) */
581 #define TWCP_NONE 0
582 #define TWCP_PACKBITS 1
583 #define TWCP_GROUP31D 2 /* Follows CCITT spec (no End Of Line) */
584 #define TWCP_GROUP31DEOL 3 /* Follows CCITT spec (has End Of Line) */
585 #define TWCP_GROUP32D 4 /* Follows CCITT spec (use cap for K Factor) */
586 #define TWCP_GROUP4 5 /* Follows CCITT spec */
587 #define TWCP_JPEG 6 /* Use capability for more info */
588 #define TWCP_LZW 7 /* Must license from Unisys and IBM to use */
589 #define TWCP_JBIG 8 /* For Bitonal images -- Added 1.7 KHL */
590 /* Added 1.8 */
591 #define TWCP_PNG 9
592 #define TWCP_RLE4 10
593 #define TWCP_RLE8 11
594 #define TWCP_BITFIELDS 12
597 /* ICAP_IMAGEFILEFORMAT values (FF_means File Format) */
598 #define TWFF_TIFF 0 /* Tagged Image File Format */
599 #define TWFF_PICT 1 /* Macintosh PICT */
600 #define TWFF_BMP 2 /* Windows Bitmap */
601 #define TWFF_XBM 3 /* X-Windows Bitmap */
602 #define TWFF_JFIF 4 /* JPEG File Interchange Format */
603 #define TWFF_FPX 5 /* Flash Pix */
604 #define TWFF_TIFFMULTI 6 /* Multi-page tiff file */
605 #define TWFF_PNG 7
606 #define TWFF_SPIFF 8
607 #define TWFF_EXIF 9
610 /* ICAP_FILTER values (FT_ means Filter Type) */
611 #define TWFT_RED 0
612 #define TWFT_GREEN 1
613 #define TWFT_BLUE 2
614 #define TWFT_NONE 3
615 #define TWFT_WHITE 4
616 #define TWFT_CYAN 5
617 #define TWFT_MAGENTA 6
618 #define TWFT_YELLOW 7
619 #define TWFT_BLACK 8
621 /* ICAP_LIGHTPATH values (LP_ means Light Path) */
622 #define TWLP_REFLECTIVE 0
623 #define TWLP_TRANSMISSIVE 1
625 /* ICAP_LIGHTSOURCE values (LS_ means Light Source) */
626 #define TWLS_RED 0
627 #define TWLS_GREEN 1
628 #define TWLS_BLUE 2
629 #define TWLS_NONE 3
630 #define TWLS_WHITE 4
631 #define TWLS_UV 5
632 #define TWLS_IR 6
634 /* ICAP_ORIENTATION values (OR_ means ORientation) */
635 #define TWOR_ROT0 0
636 #define TWOR_ROT90 1
637 #define TWOR_ROT180 2
638 #define TWOR_ROT270 3
639 #define TWOR_PORTRAIT TWOR_ROT0
640 #define TWOR_LANDSCAPE TWOR_ROT270
642 /* ICAP_PLANARCHUNKY values (PC_ means Planar/Chunky ) */
643 #define TWPC_CHUNKY 0
644 #define TWPC_PLANAR 1
646 /* ICAP_PIXELFLAVOR values (PF_ means Pixel Flavor) */
647 #define TWPF_CHOCOLATE 0 /* zero pixel represents darkest shade */
648 #define TWPF_VANILLA 1 /* zero pixel represents lightest shade */
650 /* ICAP_PIXELTYPE values (PT_ means Pixel Type) */
651 #define TWPT_BW 0 /* Black and White */
652 #define TWPT_GRAY 1
653 #define TWPT_RGB 2
654 #define TWPT_PALETTE 3
655 #define TWPT_CMY 4
656 #define TWPT_CMYK 5
657 #define TWPT_YUV 6
658 #define TWPT_YUVK 7
659 #define TWPT_CIEXYZ 8
661 /* ICAP_SUPPORTEDSIZES values (SS_ means Supported Sizes) */
662 #define TWSS_NONE 0
663 #define TWSS_A4LETTER 1
664 #define TWSS_B5LETTER 2
665 #define TWSS_USLETTER 3
666 #define TWSS_USLEGAL 4
667 /* Added 1.5 */
668 #define TWSS_A5 5
669 #define TWSS_B4 6
670 #define TWSS_B6 7
671 /*#define TWSS_B 8 */
672 /* Added 1.7 */
673 #define TWSS_USLEDGER 9
674 #define TWSS_USEXECUTIVE 10
675 #define TWSS_A3 11
676 #define TWSS_B3 12
677 #define TWSS_A6 13
678 #define TWSS_C4 14
679 #define TWSS_C5 15
680 #define TWSS_C6 16
681 /* Added 1.8 */
682 #define TWSS_4A0 17
683 #define TWSS_2A0 18
684 #define TWSS_A0 19
685 #define TWSS_A1 20
686 #define TWSS_A2 21
687 #define TWSS_A4 TWSS_A4LETTER
688 #define TWSS_A7 22
689 #define TWSS_A8 23
690 #define TWSS_A9 24
691 #define TWSS_A10 25
692 #define TWSS_ISOB0 26
693 #define TWSS_ISOB1 27
694 #define TWSS_ISOB2 28
695 #define TWSS_ISOB3 TWSS_B3
696 #define TWSS_ISOB4 TWSS_B4
697 #define TWSS_ISOB5 29
698 #define TWSS_ISOB6 TWSS_B6
699 #define TWSS_ISOB7 30
700 #define TWSS_ISOB8 31
701 #define TWSS_ISOB9 32
702 #define TWSS_ISOB10 33
703 #define TWSS_JISB0 34
704 #define TWSS_JISB1 35
705 #define TWSS_JISB2 36
706 #define TWSS_JISB3 37
707 #define TWSS_JISB4 38
708 #define TWSS_JISB5 TWSS_B5LETTER
709 #define TWSS_JISB6 39
710 #define TWSS_JISB7 40
711 #define TWSS_JISB8 41
712 #define TWSS_JISB9 42
713 #define TWSS_JISB10 43
714 #define TWSS_C0 44
715 #define TWSS_C1 45
716 #define TWSS_C2 46
717 #define TWSS_C3 47
718 #define TWSS_C7 48
719 #define TWSS_C8 49
720 #define TWSS_C9 50
721 #define TWSS_C10 51
722 #define TWSS_USSTATEMENT 52
723 #define TWSS_BUSINESSCARD 53
725 /* ICAP_XFERMECH values (SX_ means Setup XFer) */
726 #define TWSX_NATIVE 0
727 #define TWSX_FILE 1
728 #define TWSX_MEMORY 2
730 /* ICAP_UNITS values (UN_ means UNits) */
731 #define TWUN_INCHES 0
732 #define TWUN_CENTIMETERS 1
733 #define TWUN_PICAS 2
734 #define TWUN_POINTS 3
735 #define TWUN_TWIPS 4
736 #define TWUN_PIXELS 5
738 /* Added 1.5 */
739 /* ICAP_BITDEPTHREDUCTION values (BR_ means Bitdepth Reduction) */
740 #define TWBR_THRESHOLD 0
741 #define TWBR_HALFTONE 1
742 #define TWBR_CUSTHALFTONE 2
743 #define TWBR_DIFFUSION 3
745 /* Added 1.7 */
746 /* ICAP_DUPLEX values */
747 #define TWDX_NONE 0
748 #define TWDX_1PASSDUPLEX 1
749 #define TWDX_2PASSDUPLEX 2
751 /* Added 1.7 */
752 /* TWEI_BARCODETYPE values */
753 #define TWBT_3OF9 0
754 #define TWBT_2OF5INTERLEAVED 1
755 #define TWBT_2OF5NONINTERLEAVED 2
756 #define TWBT_CODE93 3
757 #define TWBT_CODE128 4
758 #define TWBT_UCC128 5
759 #define TWBT_CODABAR 6
760 #define TWBT_UPCA 7
761 #define TWBT_UPCE 8
762 #define TWBT_EAN8 9
763 #define TWBT_EAN13 10
764 #define TWBT_POSTNET 11
765 #define TWBT_PDF417 12
766 /* Added 1.8 */
767 #define TWBT_2OF5INDUSTRIAL 13
768 #define TWBT_2OF5MATRIX 14
769 #define TWBT_2OF5DATALOGIC 15
770 #define TWBT_2OF5IATA 16
771 #define TWBT_3OF9FULLASCII 17
772 #define TWBT_CODABARWITHSTARTSTOP 18
773 #define TWBT_MAXICODE 19
775 /* Added 1.7 */
776 /* TWEI_DESKEWSTATUS values */
777 #define TWDSK_SUCCESS 0
778 #define TWDSK_REPORTONLY 1
779 #define TWDSK_FAIL 2
780 #define TWDSK_DISABLED 3
782 /* Added 1.7 */
783 /* TWEI_PATCHCODE values */
784 #define TWPCH_PATCH1 0
785 #define TWPCH_PATCH2 1
786 #define TWPCH_PATCH3 2
787 #define TWPCH_PATCH4 3
788 #define TWPCH_PATCH6 4
789 #define TWPCH_PATCHT 5
791 /* Added 1.7 */
792 /* CAP_JOBCONTROL values */
793 #define TWJC_NONE 0
794 #define TWJC_JSIC 1
795 #define TWJC_JSIS 2
796 #define TWJC_JSXC 3
797 #define TWJC_JSXS 4
799 /* Added 1.7 */
800 /* TWEI_BARCODEROTATION values (BCOR_ means barcode rotation) */
801 #define TWBCOR_ROT0 0
802 #define TWBCOR_ROT90 1
803 #define TWBCOR_ROT180 2
804 #define TWBCOR_ROT270 3
805 #define TWBCOR_ROTX 4
807 /* Added 1.8 */
808 /* ACAP_AUDIOFILEFORMAT values (AF_ means audio format) */
809 #define TWAF_WAV 0
810 #define TWAF_AIFF 1
811 #define TWAF_AU 3
812 #define TWAF_SND 4
814 /* CAP_ALARMS values (AL_ means alarms) */
815 #define TWAL_ALARM 0
816 #define TWAL_FEEDERERROR 1
817 #define TWAL_FEEDERWARNING 2
818 #define TWAL_BARCODE 3
819 #define TWAL_DOUBLEFEED 4
820 #define TWAL_JAM 5
821 #define TWAL_PATCHCODE 6
822 #define TWAL_POWER 7
823 #define TWAL_SKEW 8
825 /* CAP_CLEARBUFFERS values (CB_ means clear buffers) */
826 #define TWCB_AUTO 0
827 #define TWCB_CLEAR 1
828 #define TWCB_NOCLEAR 2
830 /* CAP_DEVICEEVENT values (DE_ means device event) */
831 #define TWDE_CUSTOMEVENTS 0x8000
832 #define TWDE_CHECKAUTOMATICCAPTURE 0
833 #define TWDE_CHECKBATTERY 1
834 #define TWDE_CHECKDEVICEONLINE 2
835 #define TWDE_CHECKFLASH 3
836 #define TWDE_CHECKPOWERSUPPLY 4
837 #define TWDE_CHECKRESOLUTION 5
838 #define TWDE_DEVICEADDED 6
839 #define TWDE_DEVICEOFFLINE 7
840 #define TWDE_DEVICEREADY 8
841 #define TWDE_DEVICEREMOVED 9
842 #define TWDE_IMAGECAPTURED 10
843 #define TWDE_IMAGEDELETED 11
844 #define TWDE_PAPERDOUBLEFEED 12
845 #define TWDE_PAPERJAM 13
846 #define TWDE_LAMPFAILURE 14
847 #define TWDE_POWERSAVE 15
848 #define TWDE_POWERSAVENOTIFY 16
850 /* CAP_FEEDERALIGNMENT values (FA_ means feeder alignment) */
851 #define TWFA_NONE 0
852 #define TWFA_LEFT 1
853 #define TWFA_CENTER 2
854 #define TWFA_RIGHT 3
856 /* CAP_FEEDERORDER values (FO_ means feeder order) */
857 #define TWFO_FIRSTPAGEFIRST 0
858 #define TWFO_LASTPAGEFIRST 1
860 /* CAP_FILESYSTEM values (FS_ means file system) */
861 #define TWFS_FILESYSTEM 0
862 #define TWFS_RECURSIVEDELETE 1
864 /* CAP_POWERSUPPLY values (PS_ means power supply) */
865 #define TWPS_EXTERNAL 0
866 #define TWPS_BATTERY 1
868 /* CAP_PRINTER values (PR_ means printer) */
869 #define TWPR_IMPRINTERTOPBEFORE 0
870 #define TWPR_IMPRINTERTOPAFTER 1
871 #define TWPR_IMPRINTERBOTTOMBEFORE 2
872 #define TWPR_IMPRINTERBOTTOMAFTER 3
873 #define TWPR_ENDORSERTOPBEFORE 4
874 #define TWPR_ENDORSERTOPAFTER 5
875 #define TWPR_ENDORSERBOTTOMBEFORE 6
876 #define TWPR_ENDORSERBOTTOMAFTER 7
878 /* CAP_PRINTERMODE values (PM_ means printer mode) */
879 #define TWPM_SINGLESTRING 0
880 #define TWPM_MULTISTRING 1
881 #define TWPM_COMPOUNDSTRING 2
883 /* ICAP_BARCODESEARCHMODE values (TWBD_ means search) */
884 #define TWBD_HORZ 0
885 #define TWBD_VERT 1
886 #define TWBD_HORZVERT 2
887 #define TWBD_VERTHORZ 3
889 /* ICAP_FLASHUSED2 values (FL_ means flash) */
890 #define TWFL_NONE 0
891 #define TWFL_OFF 1
892 #define TWFL_ON 2
893 #define TWFL_AUTO 3
894 #define TWFL_REDEYE 4
896 /* ICAP_FLIPROTATION values (FR_ means flip rotation) */
897 #define TWFR_BOOK 0
898 #define TWFR_FANFOLD 1
900 /* ICAP_IMAGEFILTER values (IF_ means image filter) */
901 #define TWIF_NONE 0
902 #define TWIF_AUTO 1
903 #define TWIF_LOWPASS 2
904 #define TWIF_BANDPASS 3
905 #define TWIF_HIGHPASS 4
906 #define TWIF_TEXT TWIF_BANDPASS
907 #define TWIF_FINELINE TWIF_HIGHPASS
909 /* ICAP_NOISEFILTER values (NF_ means noise filter) */
910 #define TWNF_NONE 0
911 #define TWNF_AUTO 1
912 #define TWNF_LONEPIXEL 2
913 #define TWNF_MAJORITYRULE 3
915 /* ICAP_OVERSCAN values (OV_ means overscan) */
916 #define TWOV_NONE 0
917 #define TWOV_AUTO 1
918 #define TWOV_TOPBOTTOM 2
919 #define TWOV_LEFTRIGHT 3
920 #define TWOV_ALL 4
922 /* TW_FILESYSTEM.FileType values (FT_ means file type) */
923 #define TWFY_CAMERA 0
924 #define TWFY_CAMERATOP 1
925 #define TWFY_CAMERABOTTOM 2
926 #define TWFY_CAMERAPREVIEW 3
927 #define TWFY_DOMAIN 4
928 #define TWFY_HOST 5
929 #define TWFY_DIRECTORY 6
930 #define TWFY_IMAGE 7
931 #define TWFY_UNKNOWN 8
933 /****************************************************************************
934 * Country Constants *
935 ****************************************************************************/
937 #define TWCY_AFGHANISTAN 1001
938 #define TWCY_ALGERIA 213
939 #define TWCY_AMERICANSAMOA 684
940 #define TWCY_ANDORRA 033
941 #define TWCY_ANGOLA 1002
942 #define TWCY_ANGUILLA 8090
943 #define TWCY_ANTIGUA 8091
944 #define TWCY_ARGENTINA 54
945 #define TWCY_ARUBA 297
946 #define TWCY_ASCENSIONI 247
947 #define TWCY_AUSTRALIA 61
948 #define TWCY_AUSTRIA 43
949 #define TWCY_BAHAMAS 8092
950 #define TWCY_BAHRAIN 973
951 #define TWCY_BANGLADESH 880
952 #define TWCY_BARBADOS 8093
953 #define TWCY_BELGIUM 32
954 #define TWCY_BELIZE 501
955 #define TWCY_BENIN 229
956 #define TWCY_BERMUDA 8094
957 #define TWCY_BHUTAN 1003
958 #define TWCY_BOLIVIA 591
959 #define TWCY_BOTSWANA 267
960 #define TWCY_BRITAIN 6
961 #define TWCY_BRITVIRGINIS 8095
962 #define TWCY_BRAZIL 55
963 #define TWCY_BRUNEI 673
964 #define TWCY_BULGARIA 359
965 #define TWCY_BURKINAFASO 1004
966 #define TWCY_BURMA 1005
967 #define TWCY_BURUNDI 1006
968 #define TWCY_CAMAROON 237
969 #define TWCY_CANADA 2
970 #define TWCY_CAPEVERDEIS 238
971 #define TWCY_CAYMANIS 8096
972 #define TWCY_CENTRALAFREP 1007
973 #define TWCY_CHAD 1008
974 #define TWCY_CHILE 56
975 #define TWCY_CHINA 86
976 #define TWCY_CHRISTMASIS 1009
977 #define TWCY_COCOSIS 1009
978 #define TWCY_COLOMBIA 57
979 #define TWCY_COMOROS 1010
980 #define TWCY_CONGO 1011
981 #define TWCY_COOKIS 1012
982 #define TWCY_COSTARICA 506
983 #define TWCY_CUBA 005
984 #define TWCY_CYPRUS 357
985 #define TWCY_CZECHOSLOVAKIA 42
986 #define TWCY_DENMARK 45
987 #define TWCY_DJIBOUTI 1013
988 #define TWCY_DOMINICA 8097
989 #define TWCY_DOMINCANREP 8098
990 #define TWCY_EASTERIS 1014
991 #define TWCY_ECUADOR 593
992 #define TWCY_EGYPT 20
993 #define TWCY_ELSALVADOR 503
994 #define TWCY_EQGUINEA 1015
995 #define TWCY_ETHIOPIA 251
996 #define TWCY_FALKLANDIS 1016
997 #define TWCY_FAEROEIS 298
998 #define TWCY_FIJIISLANDS 679
999 #define TWCY_FINLAND 358
1000 #define TWCY_FRANCE 33
1001 #define TWCY_FRANTILLES 596
1002 #define TWCY_FRGUIANA 594
1003 #define TWCY_FRPOLYNEISA 689
1004 #define TWCY_FUTANAIS 1043
1005 #define TWCY_GABON 241
1006 #define TWCY_GAMBIA 220
1007 #define TWCY_GERMANY 49
1008 #define TWCY_GHANA 233
1009 #define TWCY_GIBRALTER 350
1010 #define TWCY_GREECE 30
1011 #define TWCY_GREENLAND 299
1012 #define TWCY_GRENADA 8099
1013 #define TWCY_GRENEDINES 8015
1014 #define TWCY_GUADELOUPE 590
1015 #define TWCY_GUAM 671
1016 #define TWCY_GUANTANAMOBAY 5399
1017 #define TWCY_GUATEMALA 502
1018 #define TWCY_GUINEA 224
1019 #define TWCY_GUINEABISSAU 1017
1020 #define TWCY_GUYANA 592
1021 #define TWCY_HAITI 509
1022 #define TWCY_HONDURAS 504
1023 #define TWCY_HONGKONG 852
1024 #define TWCY_HUNGARY 36
1025 #define TWCY_ICELAND 354
1026 #define TWCY_INDIA 91
1027 #define TWCY_INDONESIA 62
1028 #define TWCY_IRAN 98
1029 #define TWCY_IRAQ 964
1030 #define TWCY_IRELAND 353
1031 #define TWCY_ISRAEL 972
1032 #define TWCY_ITALY 39
1033 #define TWCY_IVORYCOAST 225
1034 #define TWCY_JAMAICA 8010
1035 #define TWCY_JAPAN 81
1036 #define TWCY_JORDAN 962
1037 #define TWCY_KENYA 254
1038 #define TWCY_KIRIBATI 1018
1039 #define TWCY_KOREA 82
1040 #define TWCY_KUWAIT 965
1041 #define TWCY_LAOS 1019
1042 #define TWCY_LEBANON 1020
1043 #define TWCY_LIBERIA 231
1044 #define TWCY_LIBYA 218
1045 #define TWCY_LIECHTENSTEIN 41
1046 #define TWCY_LUXENBOURG 352
1047 #define TWCY_MACAO 853
1048 #define TWCY_MADAGASCAR 1021
1049 #define TWCY_MALAWI 265
1050 #define TWCY_MALAYSIA 60
1051 #define TWCY_MALDIVES 960
1052 #define TWCY_MALI 1022
1053 #define TWCY_MALTA 356
1054 #define TWCY_MARSHALLIS 692
1055 #define TWCY_MAURITANIA 1023
1056 #define TWCY_MAURITIUS 230
1057 #define TWCY_MEXICO 3
1058 #define TWCY_MICRONESIA 691
1059 #define TWCY_MIQUELON 508
1060 #define TWCY_MONACO 33
1061 #define TWCY_MONGOLIA 1024
1062 #define TWCY_MONTSERRAT 8011
1063 #define TWCY_MOROCCO 212
1064 #define TWCY_MOZAMBIQUE 1025
1065 #define TWCY_NAMIBIA 264
1066 #define TWCY_NAURU 1026
1067 #define TWCY_NEPAL 977
1068 #define TWCY_NETHERLANDS 31
1069 #define TWCY_NETHANTILLES 599
1070 #define TWCY_NEVIS 8012
1071 #define TWCY_NEWCALEDONIA 687
1072 #define TWCY_NEWZEALAND 64
1073 #define TWCY_NICARAGUA 505
1074 #define TWCY_NIGER 227
1075 #define TWCY_NIGERIA 234
1076 #define TWCY_NIUE 1027
1077 #define TWCY_NORFOLKI 1028
1078 #define TWCY_NORWAY 47
1079 #define TWCY_OMAN 968
1080 #define TWCY_PAKISTAN 92
1081 #define TWCY_PALAU 1029
1082 #define TWCY_PANAMA 507
1083 #define TWCY_PARAGUAY 595
1084 #define TWCY_PERU 51
1085 #define TWCY_PHILLIPPINES 63
1086 #define TWCY_PITCAIRNIS 1030
1087 #define TWCY_PNEWGUINEA 675
1088 #define TWCY_POLAND 48
1089 #define TWCY_PORTUGAL 351
1090 #define TWCY_QATAR 974
1091 #define TWCY_REUNIONI 1031
1092 #define TWCY_ROMANIA 40
1093 #define TWCY_RWANDA 250
1094 #define TWCY_SAIPAN 670
1095 #define TWCY_SANMARINO 39
1096 #define TWCY_SAOTOME 1033
1097 #define TWCY_SAUDIARABIA 966
1098 #define TWCY_SENEGAL 221
1099 #define TWCY_SEYCHELLESIS 1034
1100 #define TWCY_SIERRALEONE 1035
1101 #define TWCY_SINGAPORE 65
1102 #define TWCY_SOLOMONIS 1036
1103 #define TWCY_SOMALI 1037
1104 #define TWCY_SOUTHAFRICA 27
1105 #define TWCY_SPAIN 34
1106 #define TWCY_SRILANKA 94
1107 #define TWCY_STHELENA 1032
1108 #define TWCY_STKITTS 8013
1109 #define TWCY_STLUCIA 8014
1110 #define TWCY_STPIERRE 508
1111 #define TWCY_STVINCENT 8015
1112 #define TWCY_SUDAN 1038
1113 #define TWCY_SURINAME 597
1114 #define TWCY_SWAZILAND 268
1115 #define TWCY_SWEDEN 46
1116 #define TWCY_SWITZERLAND 41
1117 #define TWCY_SYRIA 1039
1118 #define TWCY_TAIWAN 886
1119 #define TWCY_TANZANIA 255
1120 #define TWCY_THAILAND 66
1121 #define TWCY_TOBAGO 8016
1122 #define TWCY_TOGO 228
1123 #define TWCY_TONGAIS 676
1124 #define TWCY_TRINIDAD 8016
1125 #define TWCY_TUNISIA 216
1126 #define TWCY_TURKEY 90
1127 #define TWCY_TURKSCAICOS 8017
1128 #define TWCY_TUVALU 1040
1129 #define TWCY_UGANDA 256
1130 #define TWCY_USSR 7
1131 #define TWCY_UAEMIRATES 971
1132 #define TWCY_UNITEDKINGDOM 44
1133 #define TWCY_USA 1
1134 #define TWCY_URUGUAY 598
1135 #define TWCY_VANUATU 1041
1136 #define TWCY_VATICANCITY 39
1137 #define TWCY_VENEZUELA 58
1138 #define TWCY_WAKE 1042
1139 #define TWCY_WALLISIS 1043
1140 #define TWCY_WESTERNSAHARA 1044
1141 #define TWCY_WESTERNSAMOA 1045
1142 #define TWCY_YEMEN 1046
1143 #define TWCY_YUGOSLAVIA 38
1144 #define TWCY_ZAIRE 243
1145 #define TWCY_ZAMBIA 260
1146 #define TWCY_ZIMBABWE 263
1147 /* Added for 1.8 */
1148 #define TWCY_ALBANIA 355
1149 #define TWCY_ARMENIA 374
1150 #define TWCY_AZERBAIJAN 994
1151 #define TWCY_BELARUS 375
1152 #define TWCY_BOSNIAHERZGO 387
1153 #define TWCY_CAMBODIA 855
1154 #define TWCY_CROATIA 385
1155 #define TWCY_CZECHREPUBLIC 420
1156 #define TWCY_DIEGOGARCIA 246
1157 #define TWCY_ERITREA 291
1158 #define TWCY_ESTONIA 372
1159 #define TWCY_GEORGIA 995
1160 #define TWCY_LATVIA 371
1161 #define TWCY_LESOTHO 266
1162 #define TWCY_LITHUANIA 370
1163 #define TWCY_MACEDONIA 389
1164 #define TWCY_MAYOTTEIS 269
1165 #define TWCY_MOLDOVA 373
1166 #define TWCY_MYANMAR 95
1167 #define TWCY_NORTHKOREA 850
1168 #define TWCY_PUERTORICO 787
1169 #define TWCY_RUSSIA 7
1170 #define TWCY_SERBIA 381
1171 #define TWCY_SLOVAKIA 421
1172 #define TWCY_SLOVENIA 386
1173 #define TWCY_SOUTHKOREA 82
1174 #define TWCY_UKRAINE 380
1175 #define TWCY_USVIRGINIS 340
1176 #define TWCY_VIETNAM 84
1178 /****************************************************************************
1179 * Language Constants *
1180 ****************************************************************************/
1182 #define TWLG_DAN 0 /* Danish */
1183 #define TWLG_DUT 1 /* Dutch */
1184 #define TWLG_ENG 2 /* International English */
1185 #define TWLG_FCF 3 /* French Canadian */
1186 #define TWLG_FIN 4 /* Finnish */
1187 #define TWLG_FRN 5 /* French */
1188 #define TWLG_GER 6 /* German */
1189 #define TWLG_ICE 7 /* Icelandic */
1190 #define TWLG_ITN 8 /* Italian */
1191 #define TWLG_NOR 9 /* Norwegian */
1192 #define TWLG_POR 10 /* Portuguese */
1193 #define TWLG_SPA 11 /* Spanish */
1194 #define TWLG_SWE 12 /* Swedish */
1195 #define TWLG_USA 13 /* U.S. English */
1196 /* Added for 1.8 */
1197 #define TWLG_USERLOCALE -1
1198 #define TWLG_AFRIKAANS 14
1199 #define TWLG_ALBANIA 15
1200 #define TWLG_ARABIC 16
1201 #define TWLG_ARABIC_ALGERIA 17
1202 #define TWLG_ARABIC_BAHRAIN 18
1203 #define TWLG_ARABIC_EGYPT 19
1204 #define TWLG_ARABIC_IRAQ 20
1205 #define TWLG_ARABIC_JORDAN 21
1206 #define TWLG_ARABIC_KUWAIT 22
1207 #define TWLG_ARABIC_LEBANON 23
1208 #define TWLG_ARABIC_LIBYA 24
1209 #define TWLG_ARABIC_MOROCCO 25
1210 #define TWLG_ARABIC_OMAN 26
1211 #define TWLG_ARABIC_QATAR 27
1212 #define TWLG_ARABIC_SAUDIARABIA 28
1213 #define TWLG_ARABIC_SYRIA 29
1214 #define TWLG_ARABIC_TUNISIA 30
1215 #define TWLG_ARABIC_UAE 31 /* United Arabic Emirates */
1216 #define TWLG_ARABIC_YEMEN 32
1217 #define TWLG_BASQUE 33
1218 #define TWLG_BYELORUSSIAN 34
1219 #define TWLG_BULGARIAN 35
1220 #define TWLG_CATALAN 36
1221 #define TWLG_CHINESE 37
1222 #define TWLG_CHINESE_HONGKONG 38
1223 #define TWLG_CHINESE_PRC 39 /* People's Republic of China */
1224 #define TWLG_CHINESE_SINGAPORE 40
1225 #define TWLG_CHINESE_SIMPLIFIED 41
1226 #define TWLG_CHINESE_TAIWAN 42
1227 #define TWLG_CHINESE_TRADITIONAL 43
1228 #define TWLG_CROATIA 44
1229 #define TWLG_CZECH 45
1230 #define TWLG_DANISH TWLG_DAN
1231 #define TWLG_DUTCH TWLG_DUT
1232 #define TWLG_DUTCH_BELGIAN 46
1233 #define TWLG_ENGLISH TWLG_ENG
1234 #define TWLG_ENGLISH_AUSTRALIAN 47
1235 #define TWLG_ENGLISH_CANADIAN 48
1236 #define TWLG_ENGLISH_IRELAND 49
1237 #define TWLG_ENGLISH_NEWZEALAND 50
1238 #define TWLG_ENGLISH_SOUTHAFRICA 51
1239 #define TWLG_ENGLISH_UK 52
1240 #define TWLG_ENGLISH_USA TWLG_USA
1241 #define TWLG_ESTONIAN 53
1242 #define TWLG_FAEROESE 54
1243 #define TWLG_FARSI 55
1244 #define TWLG_FINNISH TWLG_FIN
1245 #define TWLG_FRENCH TWLG_FRN
1246 #define TWLG_FRENCH_BELGIAN 56
1247 #define TWLG_FRENCH_CANADIAN TWLG_FCF
1248 #define TWLG_FRENCH_LUXEMBOURG 57
1249 #define TWLG_FRENCH_SWISS 58
1250 #define TWLG_GERMAN TWLG_GER
1251 #define TWLG_GERMAN_AUSTRIAN 59
1252 #define TWLG_GERMAN_LUXEMBOURG 60
1253 #define TWLG_GERMAN_LIECHTENSTEIN 61
1254 #define TWLG_GERMAN_SWISS 62
1255 #define TWLG_GREEK 63
1256 #define TWLG_HEBREW 64
1257 #define TWLG_HUNGARIAN 65
1258 #define TWLG_ICELANDIC TWLG_ICE
1259 #define TWLG_INDONESIAN 66
1260 #define TWLG_ITALIAN TWLG_ITN
1261 #define TWLG_ITALIAN_SWISS 67
1262 #define TWLG_JAPANESE 68
1263 #define TWLG_KOREAN 69
1264 #define TWLG_KOREAN_JOHAB 70
1265 #define TWLG_LATVIAN 71
1266 #define TWLG_LITHUANIAN 72
1267 #define TWLG_NORWEGIAN TWLG_NOR
1268 #define TWLG_NORWEGIAN_BOKMAL 73
1269 #define TWLG_NORWEGIAN_NYNORSK 74
1270 #define TWLG_POLISH 75
1271 #define TWLG_PORTUGUESE TWLG_POR
1272 #define TWLG_PORTUGUESE_BRAZIL 76
1273 #define TWLG_ROMANIAN 77
1274 #define TWLG_RUSSIAN 78
1275 #define TWLG_SERBIAN_LATIN 79
1276 #define TWLG_SLOVAK 80
1277 #define TWLG_SLOVENIAN 81
1278 #define TWLG_SPANISH TWLG_SPA
1279 #define TWLG_SPANISH_MEXICAN 82
1280 #define TWLG_SPANISH_MODERN 83
1281 #define TWLG_SWEDISH TWLG_SWE
1282 #define TWLG_THAI 84
1283 #define TWLG_TURKISH 85
1284 #define TWLG_UKRANIAN 86
1285 /* More stuff added for 1.8 */
1286 #define TWLG_ASSAMESE 87
1287 #define TWLG_BENGALI 88
1288 #define TWLG_BIHARI 89
1289 #define TWLG_BODO 90
1290 #define TWLG_DOGRI 91
1291 #define TWLG_GUJARATI 92
1292 #define TWLG_HARYANVI 93
1293 #define TWLG_HINDI 94
1294 #define TWLG_KANNADA 95
1295 #define TWLG_KASHMIRI 96
1296 #define TWLG_MALAYALAM 97
1297 #define TWLG_MARATHI 98
1298 #define TWLG_MARWARI 99
1299 #define TWLG_MEGHALAYAN 100
1300 #define TWLG_MIZO 101
1301 #define TWLG_NAGA 102
1302 #define TWLG_ORISSI 103
1303 #define TWLG_PUNJABI 104
1304 #define TWLG_PUSHTU 105
1305 #define TWLG_SERBIAN_CYRILLIC 106
1306 #define TWLG_SIKKIMI 107
1307 #define TWLG_SWEDISH_FINLAND 108
1308 #define TWLG_TAMIL 109
1309 #define TWLG_TELUGU 110
1310 #define TWLG_TRIPURI 111
1311 #define TWLG_URDU 112
1312 #define TWLG_VIETNAMESE 113
1314 /****************************************************************************
1315 * Data Groups *
1316 ****************************************************************************/
1318 /* More Data Groups may be added in the future.
1319 * Possible candidates include text, vector graphics, sound, etc.
1320 * NOTE: Data Group constants must be powers of 2 as they are used
1321 * as bitflags when Application asks DSM to present a list of DSs.
1324 #define DG_CONTROL 0x0001L /* data pertaining to control */
1325 #define DG_IMAGE 0x0002L /* data pertaining to raster images */
1326 /* Added 1.8 */
1327 #define DG_AUDIO 0x0004L /* data pertaining to audio */
1329 /****************************************************************************
1330 * Data Argument Types *
1331 ****************************************************************************/
1333 /* SDH - 03/23/95 - WATCH */
1334 /* The thunker requires knowledge about size of data being passed in the */
1335 /* lpData parameter to DS_Entry (which is not readily available due to */
1336 /* type LPVOID. Thus, we key off the DAT_ argument to determine the size. */
1337 /* This has a couple implications: */
1338 /* 1) Any additional DAT_ features require modifications to the thunk code */
1339 /* for thunker support. */
1340 /* 2) Any applications which use the custom capabilities are not supported */
1341 /* under thunking since we have no way of knowing what size data (if */
1342 /* any) is being passed. */
1344 #define DAT_NULL 0x0000 /* No data or structure. */
1345 #define DAT_CUSTOMBASE 0x8000 /* Base of custom DATs. */
1347 /* Data Argument Types for the DG_CONTROL Data Group. */
1348 #define DAT_CAPABILITY 0x0001 /* TW_CAPABILITY */
1349 #define DAT_EVENT 0x0002 /* TW_EVENT */
1350 #define DAT_IDENTITY 0x0003 /* TW_IDENTITY */
1351 #define DAT_PARENT 0x0004 /* TW_HANDLE, application win handle in Windows */
1352 #define DAT_PENDINGXFERS 0x0005 /* TW_PENDINGXFERS */
1353 #define DAT_SETUPMEMXFER 0x0006 /* TW_SETUPMEMXFER */
1354 #define DAT_SETUPFILEXFER 0x0007 /* TW_SETUPFILEXFER */
1355 #define DAT_STATUS 0x0008 /* TW_STATUS */
1356 #define DAT_USERINTERFACE 0x0009 /* TW_USERINTERFACE */
1357 #define DAT_XFERGROUP 0x000a /* TW_UINT32 */
1358 /* SDH - 03/21/95 - TWUNK */
1359 /* Additional message required for thunker to request the special */
1360 /* identity information. */
1361 #define DAT_TWUNKIDENTITY 0x000b /* TW_TWUNKIDENTITY */
1362 #define DAT_CUSTOMDSDATA 0x000c /* TW_CUSTOMDSDATA. */
1363 /* Added 1.8 */
1364 #define DAT_DEVICEEVENT 0x000d /* TW_DEVICEEVENT */
1365 #define DAT_FILESYSTEM 0x000e /* TW_FILESYSTEM */
1366 #define DAT_PASSTHRU 0x000f /* TW_PASSTHRU */
1368 /* Data Argument Types for the DG_IMAGE Data Group. */
1369 #define DAT_IMAGEINFO 0x0101 /* TW_IMAGEINFO */
1370 #define DAT_IMAGELAYOUT 0x0102 /* TW_IMAGELAYOUT */
1371 #define DAT_IMAGEMEMXFER 0x0103 /* TW_IMAGEMEMXFER */
1372 #define DAT_IMAGENATIVEXFER 0x0104 /* TW_UINT32 loword is hDIB, PICHandle */
1373 #define DAT_IMAGEFILEXFER 0x0105 /* Null data */
1374 #define DAT_CIECOLOR 0x0106 /* TW_CIECOLOR */
1375 #define DAT_GRAYRESPONSE 0x0107 /* TW_GRAYRESPONSE */
1376 #define DAT_RGBRESPONSE 0x0108 /* TW_RGBRESPONSE */
1377 #define DAT_JPEGCOMPRESSION 0x0109 /* TW_JPEGCOMPRESSION */
1378 #define DAT_PALETTE8 0x010a /* TW_PALETTE8 */
1379 #define DAT_EXTIMAGEINFO 0x010b /* TW_EXTIMAGEINFO -- for 1.7 Spec. */
1381 /* Added 1.8 */
1382 /* Data Argument Types for the DG_AUDIO Data Group. */
1383 #define DAT_AUDIOFILEXFER 0x0201 /* Null data */
1384 #define DAT_AUDIOINFO 0x0202 /* TW_AUDIOINFO */
1385 #define DAT_AUDIONATIVEXFER 0x0203 /* TW_UINT32 handle to WAV, (AIFF Mac) */
1387 /****************************************************************************
1388 * Messages *
1389 ****************************************************************************/
1391 /* All message constants are unique.
1392 * Messages are grouped according to which DATs they are used with.*/
1394 #define MSG_NULL 0x0000 /* Used in TW_EVENT structure */
1395 #define MSG_CUSTOMBASE 0x8000 /* Base of custom messages */
1397 /* Generic messages may be used with any of several DATs. */
1398 #define MSG_GET 0x0001 /* Get one or more values */
1399 #define MSG_GETCURRENT 0x0002 /* Get current value */
1400 #define MSG_GETDEFAULT 0x0003 /* Get default (e.g. power up) value */
1401 #define MSG_GETFIRST 0x0004 /* Get first of a series of items, e.g. DSs */
1402 #define MSG_GETNEXT 0x0005 /* Iterate through a series of items. */
1403 #define MSG_SET 0x0006 /* Set one or more values */
1404 #define MSG_RESET 0x0007 /* Set current value to default value */
1405 #define MSG_QUERYSUPPORT 0x0008 /* Get supported operations on the cap. */
1407 /* Messages used with DAT_NULL */
1408 #define MSG_XFERREADY 0x0101 /* The data source has data ready */
1409 #define MSG_CLOSEDSREQ 0x0102 /* Request for Application. to close DS */
1410 #define MSG_CLOSEDSOK 0x0103 /* Tell the Application. to save the state. */
1411 /* Added 1.8 */
1412 #define MSG_DEVICEEVENT 0X0104 /* Some event has taken place */
1414 /* Messages used with a pointer to a DAT_STATUS structure */
1415 #define MSG_CHECKSTATUS 0x0201 /* Get status information */
1417 /* Messages used with a pointer to DAT_PARENT data */
1418 #define MSG_OPENDSM 0x0301 /* Open the DSM */
1419 #define MSG_CLOSEDSM 0x0302 /* Close the DSM */
1421 /* Messages used with a pointer to a DAT_IDENTITY structure */
1422 #define MSG_OPENDS 0x0401 /* Open a data source */
1423 #define MSG_CLOSEDS 0x0402 /* Close a data source */
1424 #define MSG_USERSELECT 0x0403 /* Put up a dialog of all DS */
1426 /* Messages used with a pointer to a DAT_USERINTERFACE structure */
1427 #define MSG_DISABLEDS 0x0501 /* Disable data transfer in the DS */
1428 #define MSG_ENABLEDS 0x0502 /* Enable data transfer in the DS */
1429 #define MSG_ENABLEDSUIONLY 0x0503 /* Enable for saving DS state only. */
1431 /* Messages used with a pointer to a DAT_EVENT structure */
1432 #define MSG_PROCESSEVENT 0x0601
1434 /* Messages used with a pointer to a DAT_PENDINGXFERS structure */
1435 #define MSG_ENDXFER 0x0701
1437 /* Added 1.8 */
1438 /* Messages used with a pointer to a DAT_FILESYSTEM structure */
1439 #define MSG_CHANGEDIRECTORY 0x0801
1440 #define MSG_CREATEDIRECTORY 0x0802
1441 #define MSG_DELETE 0x0803
1442 #define MSG_FORMATMEDIA 0x0804
1443 #define MSG_GETCLOSE 0x0805
1444 #define MSG_GETFIRSTFILE 0x0806
1445 #define MSG_GETINFO 0x0807
1446 #define MSG_GETNEXTFILE 0x0808
1447 #define MSG_RENAME 0x0809
1449 /* Messages used with a pointer to a DAT_PASSTHRU structure */
1450 #define MSG_PASSTHRU 0x0901
1452 /****************************************************************************
1453 * Capabilities *
1454 ****************************************************************************/
1456 #define CAP_CUSTOMBASE 0x8000 /* Base of custom capabilities */
1458 /* all data sources are REQUIRED to support these caps */
1459 #define CAP_XFERCOUNT 0x0001
1461 /* image data sources are REQUIRED to support these caps */
1462 #define ICAP_COMPRESSION 0x0100
1463 #define ICAP_PIXELTYPE 0x0101
1464 #define ICAP_UNITS 0x0102 /* default is TWUN_INCHES */
1465 #define ICAP_XFERMECH 0x0103
1467 /* all data sources MAY support these caps */
1468 #define CAP_AUTHOR 0x1000
1469 #define CAP_CAPTION 0x1001
1470 #define CAP_FEEDERENABLED 0x1002
1471 #define CAP_FEEDERLOADED 0x1003
1472 #define CAP_TIMEDATE 0x1004
1473 #define CAP_SUPPORTEDCAPS 0x1005
1474 #define CAP_EXTENDEDCAPS 0x1006
1475 #define CAP_AUTOFEED 0x1007
1476 #define CAP_CLEARPAGE 0x1008
1477 #define CAP_FEEDPAGE 0x1009
1478 #define CAP_REWINDPAGE 0x100a
1479 #define CAP_INDICATORS 0x100b /* Added 1.1 */
1480 #define CAP_SUPPORTEDCAPSEXT 0x100c /* Added 1.6 */
1481 #define CAP_PAPERDETECTABLE 0x100d /* Added 1.6 */
1482 #define CAP_UICONTROLLABLE 0x100e /* Added 1.6 */
1483 #define CAP_DEVICEONLINE 0x100f /* Added 1.6 */
1484 #define CAP_AUTOSCAN 0x1010 /* Added 1.6 */
1485 #define CAP_THUMBNAILSENABLED 0x1011 /* Added 1.7 */
1486 #define CAP_DUPLEX 0x1012 /* Added 1.7 */
1487 #define CAP_DUPLEXENABLED 0x1013 /* Added 1.7 */
1488 #define CAP_ENABLEDSUIONLY 0x1014 /* Added 1.7 */
1489 #define CAP_CUSTOMDSDATA 0x1015 /* Added 1.7 */
1490 #define CAP_ENDORSER 0x1016 /* Added 1.7 */
1491 #define CAP_JOBCONTROL 0x1017 /* Added 1.7 */
1492 #define CAP_ALARMS 0x1018 /* Added 1.8 */
1493 #define CAP_ALARMVOLUME 0x1019 /* Added 1.8 */
1494 #define CAP_AUTOMATICCAPTURE 0x101a /* Added 1.8 */
1495 #define CAP_TIMEBEFOREFIRSTCAPTURE 0x101b /* Added 1.8 */
1496 #define CAP_TIMEBETWEENCAPTURES 0x101c /* Added 1.8 */
1497 #define CAP_CLEARBUFFERS 0x101d /* Added 1.8 */
1498 #define CAP_MAXBATCHBUFFERS 0x101e /* Added 1.8 */
1499 #define CAP_DEVICETIMEDATE 0x101f /* Added 1.8 */
1500 #define CAP_POWERSUPPLY 0x1020 /* Added 1.8 */
1501 #define CAP_CAMERAPREVIEWUI 0x1021 /* Added 1.8 */
1502 #define CAP_DEVICEEVENT 0x1022 /* Added 1.8 */
1503 #define CAP_PAGEMULTIPLEACQUIRE 0x1023 /* Added 1.8 */
1504 #define CAP_SERIALNUMBER 0x1024 /* Added 1.8 */
1505 #define CAP_FILESYSTEM 0x1025 /* Added 1.8 */
1506 #define CAP_PRINTER 0x1026 /* Added 1.8 */
1507 #define CAP_PRINTERENABLED 0x1027 /* Added 1.8 */
1508 #define CAP_PRINTERINDEX 0x1028 /* Added 1.8 */
1509 #define CAP_PRINTERMODE 0x1029 /* Added 1.8 */
1510 #define CAP_PRINTERSTRING 0x102a /* Added 1.8 */
1511 #define CAP_PRINTERSUFFIX 0x102b /* Added 1.8 */
1512 #define CAP_LANGUAGE 0x102c /* Added 1.8 */
1513 #define CAP_FEEDERALIGNMENT 0x102d /* Added 1.8 */
1514 #define CAP_FEEDERORDER 0x102e /* Added 1.8 */
1515 #define CAP_PAPERBINDING 0x102f /* Added 1.8 */
1516 #define CAP_REACQUIREALLOWED 0x1030 /* Added 1.8 */
1517 #define CAP_PASSTHRU 0x1031 /* Added 1.8 */
1518 #define CAP_BATTERYMINUTES 0x1032 /* Added 1.8 */
1519 #define CAP_BATTERYPERCENTAGE 0x1033 /* Added 1.8 */
1520 #define CAP_POWERDOWNTIME 0x1034 /* Added 1.8 */
1522 /* image data sources MAY support these caps */
1523 #define ICAP_AUTOBRIGHT 0x1100
1524 #define ICAP_BRIGHTNESS 0x1101
1525 #define ICAP_CONTRAST 0x1103
1526 #define ICAP_CUSTHALFTONE 0x1104
1527 #define ICAP_EXPOSURETIME 0x1105
1528 #define ICAP_FILTER 0x1106
1529 #define ICAP_FLASHUSED 0x1107
1530 #define ICAP_GAMMA 0x1108
1531 #define ICAP_HALFTONES 0x1109
1532 #define ICAP_HIGHLIGHT 0x110a
1533 #define ICAP_IMAGEFILEFORMAT 0x110c
1534 #define ICAP_LAMPSTATE 0x110d
1535 #define ICAP_LIGHTSOURCE 0x110e
1536 #define ICAP_ORIENTATION 0x1110
1537 #define ICAP_PHYSICALWIDTH 0x1111
1538 #define ICAP_PHYSICALHEIGHT 0x1112
1539 #define ICAP_SHADOW 0x1113
1540 #define ICAP_FRAMES 0x1114
1541 #define ICAP_XNATIVERESOLUTION 0x1116
1542 #define ICAP_YNATIVERESOLUTION 0x1117
1543 #define ICAP_XRESOLUTION 0x1118
1544 #define ICAP_YRESOLUTION 0x1119
1545 #define ICAP_MAXFRAMES 0x111a
1546 #define ICAP_TILES 0x111b
1547 #define ICAP_BITORDER 0x111c
1548 #define ICAP_CCITTKFACTOR 0x111d
1549 #define ICAP_LIGHTPATH 0x111e
1550 #define ICAP_PIXELFLAVOR 0x111f
1551 #define ICAP_PLANARCHUNKY 0x1120
1552 #define ICAP_ROTATION 0x1121
1553 #define ICAP_SUPPORTEDSIZES 0x1122
1554 #define ICAP_THRESHOLD 0x1123
1555 #define ICAP_XSCALING 0x1124
1556 #define ICAP_YSCALING 0x1125
1557 #define ICAP_BITORDERCODES 0x1126
1558 #define ICAP_PIXELFLAVORCODES 0x1127
1559 #define ICAP_JPEGPIXELTYPE 0x1128
1560 #define ICAP_TIMEFILL 0x112a
1561 #define ICAP_BITDEPTH 0x112b
1562 #define ICAP_BITDEPTHREDUCTION 0x112c /* Added 1.5 */
1563 #define ICAP_UNDEFINEDIMAGESIZE 0x112d /* Added 1.6 */
1564 #define ICAP_IMAGEDATASET 0x112e /* Added 1.7 */
1565 #define ICAP_EXTIMAGEINFO 0x112f /* Added 1.7 */
1566 #define ICAP_MINIMUMHEIGHT 0x1130 /* Added 1.7 */
1567 #define ICAP_MINIMUMWIDTH 0x1131 /* Added 1.7 */
1568 #define ICAP_AUTODISCARDBLANKPAGES 0x1134 /* Added 1.8 */
1569 #define ICAP_FLIPROTATION 0x1136 /* Added 1.8 */
1570 #define ICAP_BARCODEDETECTIONENABLED 0x1137 /* Added 1.8 */
1571 #define ICAP_SUPPORTEDBARCODETYPES 0x1138 /* Added 1.8 */
1572 #define ICAP_BARCODEMAXSEARCHPRIORITIES 0x1139 /* Added 1.8 */
1573 #define ICAP_BARCODESEARCHPRIORITIES 0x113a /* Added 1.8 */
1574 #define ICAP_BARCODESEARCHMODE 0x113b /* Added 1.8 */
1575 #define ICAP_BARCODEMAXRETRIES 0x113c /* Added 1.8 */
1576 #define ICAP_BARCODETIMEOUT 0x113d /* Added 1.8 */
1577 #define ICAP_ZOOMFACTOR 0x113e /* Added 1.8 */
1578 #define ICAP_PATCHCODEDETECTIONENABLED 0x113f /* Added 1.8 */
1579 #define ICAP_SUPPORTEDPATCHCODETYPES 0x1140 /* Added 1.8 */
1580 #define ICAP_PATCHCODEMAXSEARCHPRIORITIES 0x1141 /* Added 1.8 */
1581 #define ICAP_PATCHCODESEARCHPRIORITIES 0x1142 /* Added 1.8 */
1582 #define ICAP_PATCHCODESEARCHMODE 0x1143 /* Added 1.8 */
1583 #define ICAP_PATCHCODEMAXRETRIES 0x1144 /* Added 1.8 */
1584 #define ICAP_PATCHCODETIMEOUT 0x1145 /* Added 1.8 */
1585 #define ICAP_FLASHUSED2 0x1146 /* Added 1.8 */
1586 #define ICAP_IMAGEFILTER 0x1147 /* Added 1.8 */
1587 #define ICAP_NOISEFILTER 0x1148 /* Added 1.8 */
1588 #define ICAP_OVERSCAN 0x1149 /* Added 1.8 */
1589 #define ICAP_AUTOMATICBORDERDETECTION 0x1150 /* Added 1.8 */
1590 #define ICAP_AUTOMATICDESKEW 0x1151 /* Added 1.8 */
1591 #define ICAP_AUTOMATICROTATE 0x1152 /* Added 1.8 */
1593 /* image data sources MAY support these audio caps */
1594 #define ACAP_AUDIOFILEFORMAT 0x1201 /* Added 1.8 */
1595 #define ACAP_XFERMECH 0x1202 /* Added 1.8 */
1597 /* ----------------------------------------------------------------------- *\
1599 Version 1.7: Following is Extended Image Info Attributes.
1600 July 1997
1603 \* ----------------------------------------------------------------------- */
1605 #define TWEI_BARCODEX 0x1200
1606 #define TWEI_BARCODEY 0x1201
1607 #define TWEI_BARCODETEXT 0x1202
1608 #define TWEI_BARCODETYPE 0x1203
1609 #define TWEI_DESHADETOP 0x1204
1610 #define TWEI_DESHADELEFT 0x1205
1611 #define TWEI_DESHADEHEIGHT 0x1206
1612 #define TWEI_DESHADEWIDTH 0x1207
1613 #define TWEI_DESHADESIZE 0x1208
1614 #define TWEI_SPECKLESREMOVED 0x1209
1615 #define TWEI_HORZLINEXCOORD 0x120A
1616 #define TWEI_HORZLINEYCOORD 0x120B
1617 #define TWEI_HORZLINELENGTH 0x120C
1618 #define TWEI_HORZLINETHICKNESS 0x120D
1619 #define TWEI_VERTLINEXCOORD 0x120E
1620 #define TWEI_VERTLINEYCOORD 0x120F
1621 #define TWEI_VERTLINELENGTH 0x1210
1622 #define TWEI_VERTLINETHICKNESS 0x1211
1623 #define TWEI_PATCHCODE 0x1212
1624 #define TWEI_ENDORSEDTEXT 0x1213
1625 #define TWEI_FORMCONFIDENCE 0x1214
1626 #define TWEI_FORMTEMPLATEMATCH 0x1215
1627 #define TWEI_FORMTEMPLATEPAGEMATCH 0x1216
1628 #define TWEI_FORMHORZDOCOFFSET 0x1217
1629 #define TWEI_FORMVERTDOCOFFSET 0x1218
1630 #define TWEI_BARCODECOUNT 0x1219
1631 #define TWEI_BARCODECONFIDENCE 0x121A
1632 #define TWEI_BARCODEROTATION 0x121B
1633 #define TWEI_BARCODETEXTLENGTH 0x121C
1634 #define TWEI_DESHADECOUNT 0x121D
1635 #define TWEI_DESHADEBLACKCOUNTOLD 0x121E
1636 #define TWEI_DESHADEBLACKCOUNTNEW 0x121F
1637 #define TWEI_DESHADEBLACKRLMIN 0x1220
1638 #define TWEI_DESHADEBLACKRLMAX 0x1221
1639 #define TWEI_DESHADEWHITECOUNTOLD 0x1222
1640 #define TWEI_DESHADEWHITECOUNTNEW 0x1223
1641 #define TWEI_DESHADEWHITERLMIN 0x1224
1642 #define TWEI_DESHADEWHITERLAVE 0x1225
1643 #define TWEI_DESHADEWHITERLMAX 0x1226
1644 #define TWEI_BLACKSPECKLESREMOVED 0x1227
1645 #define TWEI_WHITESPECKLESREMOVED 0x1228
1646 #define TWEI_HORZLINECOUNT 0x1229
1647 #define TWEI_VERTLINECOUNT 0x122A
1648 #define TWEI_DESKEWSTATUS 0x122B
1649 #define TWEI_SKEWORIGINALANGLE 0x122C
1650 #define TWEI_SKEWFINALANGLE 0x122D
1651 #define TWEI_SKEWCONFIDENCE 0x122E
1652 #define TWEI_SKEWWINDOWX1 0x122F
1653 #define TWEI_SKEWWINDOWY1 0x1230
1654 #define TWEI_SKEWWINDOWX2 0x1231
1655 #define TWEI_SKEWWINDOWY2 0x1232
1656 #define TWEI_SKEWWINDOWX3 0x1233
1657 #define TWEI_SKEWWINDOWY3 0x1234
1658 #define TWEI_SKEWWINDOWX4 0x1235
1659 #define TWEI_SKEWWINDOWY4 0x1236
1661 #define TWEJ_NONE 0x0000
1662 #define TWEJ_MIDSEPARATOR 0x0001
1663 #define TWEJ_PATCH1 0x0002
1664 #define TWEJ_PATCH2 0x0003
1665 #define TWEJ_PATCH3 0x0004
1666 #define TWEJ_PATCH4 0x0005
1667 #define TWEJ_PATCH6 0x0006
1668 #define TWEJ_PATCHT 0x0007
1670 /***************************************************************************
1671 * Return Codes and Condition Codes section *
1672 ***************************************************************************/
1674 /* Return Codes: DSM_Entry and DS_Entry may return any one of these values. */
1675 #define TWRC_CUSTOMBASE 0x8000
1677 #define TWRC_SUCCESS 0
1678 #define TWRC_FAILURE 1 /* Application may get TW_STATUS for info on failure */
1679 #define TWRC_CHECKSTATUS 2 /* "tried hard"; get status */
1680 #define TWRC_CANCEL 3
1681 #define TWRC_DSEVENT 4
1682 #define TWRC_NOTDSEVENT 5
1683 #define TWRC_XFERDONE 6
1684 #define TWRC_ENDOFLIST 7 /* After MSG_GETNEXT if nothing left */
1685 #define TWRC_INFONOTSUPPORTED 8
1686 #define TWRC_DATANOTAVAILABLE 9
1688 /* Condition Codes: Application gets these by doing DG_CONTROL DAT_STATUS MSG_GET. */
1689 #define TWCC_CUSTOMBASE 0x8000
1691 #define TWCC_SUCCESS 0 /* It worked! */
1692 #define TWCC_BUMMER 1 /* Failure due to unknown causes */
1693 #define TWCC_LOWMEMORY 2 /* Not enough memory to perform operation */
1694 #define TWCC_NODS 3 /* No Data Source */
1695 #define TWCC_MAXCONNECTIONS 4 /* DS is connected to max possible applications */
1696 #define TWCC_OPERATIONERROR 5 /* DS or DSM reported error, application shouldn't */
1697 #define TWCC_BADCAP 6 /* Unknown capability */
1698 #define TWCC_BADPROTOCOL 9 /* Unrecognized MSG DG DAT combination */
1699 #define TWCC_BADVALUE 10 /* Data parameter out of range */
1700 #define TWCC_SEQERROR 11 /* DG DAT MSG out of expected sequence */
1701 #define TWCC_BADDEST 12 /* Unknown destination Application/Source in DSM_Entry */
1702 #define TWCC_CAPUNSUPPORTED 13 /* Capability not supported by source */
1703 #define TWCC_CAPBADOPERATION 14 /* Operation not supported by capability */
1704 #define TWCC_CAPSEQERROR 15 /* Capability has dependency on other capability */
1705 /* Added 1.8 */
1706 #define TWCC_DENIED 16 /* File System operation is denied (file is protected) */
1707 #define TWCC_FILEEXISTS 17 /* Operation failed because file already exists. */
1708 #define TWCC_FILENOTFOUND 18 /* File not found */
1709 #define TWCC_NOTEMPTY 19 /* Operation failed because directory is not empty */
1710 #define TWCC_PAPERJAM 20 /* The feeder is jammed */
1711 #define TWCC_PAPERDOUBLEFEED 21 /* The feeder detected multiple pages */
1712 #define TWCC_FILEWRITEERROR 22 /* Error writing the file (meant for things like disk full conditions) */
1713 #define TWCC_CHECKDEVICEONLINE 23 /* The device went offline prior to or during this operation */
1716 /* bit patterns: for query the operation that are supported by the data source on a capability */
1717 /* Application gets these through DG_CONTROL/DAT_CAPABILITY/MSG_QUERYSUPPORT */
1718 /* Added 1.6 */
1719 #define TWQC_GET 0x0001
1720 #define TWQC_SET 0x0002
1721 #define TWQC_GETDEFAULT 0x0004
1722 #define TWQC_GETCURRENT 0x0008
1723 #define TWQC_RESET 0x0010
1726 /****************************************************************************
1727 * Entry Points *
1728 ****************************************************************************/
1730 /**********************************************************************
1731 * Function: DSM_Entry, the only entry point into the Data Source Manager.
1733 * Parameters:
1734 * pOrigin Identifies the source module of the message. This could
1735 * identify an Application, a Source, or the Source Manager.
1737 * pDest Identifies the destination module for the message.
1738 * This could identify an application or a data source.
1739 * If this is NULL, the message goes to the Source Manager.
1741 * DG The Data Group.
1742 * Example: DG_IMAGE.
1744 * DAT The Data Attribute Type.
1745 * Example: DAT_IMAGEMEMXFER.
1747 * MSG The message. Messages are interpreted by the destination module
1748 * with respect to the Data Group and the Data Attribute Type.
1749 * Example: MSG_GET.
1751 * pData A pointer to the data structure or variable identified
1752 * by the Data Attribute Type.
1753 * Example: (TW_MEMREF)&ImageMemXfer
1754 * where ImageMemXfer is a TW_IMAGEMEMXFER structure.
1756 * Returns:
1757 * ReturnCode
1758 * Example: TWRC_SUCCESS.
1760 ********************************************************************/
1762 /* Don't mangle the name "DSM_Entry" if we're compiling in C++! */
1763 #ifdef __cplusplus
1764 extern "C" {
1765 #endif /* __cplusplus */
1767 #ifdef _MSWIN_
1768 TW_UINT16 FAR PASCAL DSM_Entry( pTW_IDENTITY pOrigin,
1769 pTW_IDENTITY pDest,
1770 TW_UINT32 DG,
1771 TW_UINT16 DAT,
1772 TW_UINT16 MSG,
1773 TW_MEMREF pData);
1775 typedef TW_UINT16 (FAR PASCAL *DSMENTRYPROC)(pTW_IDENTITY, pTW_IDENTITY,
1776 TW_UINT32, TW_UINT16,
1777 TW_UINT16, TW_MEMREF);
1778 #else /* _MSWIN_ */
1780 /*FAR PASCAL TW_UINT16 DSM_Entry( pTW_IDENTITY pOrigin,
1781 pTW_IDENTITY pDest,
1782 TW_UINT32 DG,
1783 TW_UINT16 DAT,
1784 TW_UINT16 MSG,
1785 TW_MEMREF pData);*/
1787 typedef TW_UINT16 (*DSMENTRYPROC)(pTW_IDENTITY, pTW_IDENTITY,
1788 TW_UINT32, TW_UINT16,
1789 TW_UINT16, TW_MEMREF);
1790 #endif /* _MSWIN_ */
1792 #ifdef __cplusplus
1794 #endif /* cplusplus */
1797 /**********************************************************************
1798 * Function: DS_Entry, the entry point provided by a Data Source.
1800 * Parameters:
1801 * pOrigin Identifies the source module of the message. This could
1802 * identify an application or the Data Source Manager.
1804 * DG The Data Group.
1805 * Example: DG_IMAGE.
1807 * DAT The Data Attribute Type.
1808 * Example: DAT_IMAGEMEMXFER.
1810 * MSG The message. Messages are interpreted by the data source
1811 * with respect to the Data Group and the Data Attribute Type.
1812 * Example: MSG_GET.
1814 * pData A pointer to the data structure or variable identified
1815 * by the Data Attribute Type.
1816 * Example: (TW_MEMREF)&ImageMemXfer
1817 * where ImageMemXfer is a TW_IMAGEMEMXFER structure.
1819 * Returns:
1820 * ReturnCode
1821 * Example: TWRC_SUCCESS.
1823 * Note:
1824 * The DSPROC type is only used by an application when it calls
1825 * a Data Source directly, bypassing the Data Source Manager.
1827 ********************************************************************/
1828 /* Don't mangle the name "DS_Entry" if we're compiling in C++! */
1829 #ifdef __cplusplus
1830 extern "C" {
1831 #endif /* __cplusplus */
1832 #ifdef _MSWIN_
1833 # ifdef _WIN32
1834 __declspec(dllexport) TW_UINT16 FAR PASCAL DS_Entry (pTW_IDENTITY pOrigin,
1835 TW_UINT32 DG,
1836 TW_UINT16 DAT,
1837 TW_UINT16 MSG,
1838 TW_MEMREF pData);
1839 # else /* _WIN32 */
1840 TW_UINT16 FAR PASCAL DS_Entry (pTW_IDENTITY pOrigin,
1841 TW_UINT32 DG,
1842 TW_UINT16 DAT,
1843 TW_UINT16 MSG,
1844 TW_MEMREF pData);
1845 # endif /* _WIN32 */
1847 typedef TW_UINT16 (FAR PASCAL *DSENTRYPROC) (pTW_IDENTITY pOrigin,
1848 TW_UINT32 DG,
1849 TW_UINT16 DAT,
1850 TW_UINT16 MSG,
1851 TW_MEMREF pData);
1852 #else /* _MSWIN_ */
1853 /*FAR PASCAL TW_UINT16 DS_Entry( pTW_IDENTITY pOrigin,
1854 TW_UINT32 DG,
1855 TW_UINT16 DAT,
1856 TW_UINT16 MSG,
1857 TW_MEMREF pData);*/
1859 typedef TW_UINT16 (*DSENTRYPROC)(pTW_IDENTITY,
1860 TW_UINT32, TW_UINT16,
1861 TW_UINT16, TW_MEMREF);
1862 #endif /* _MSWIN_ */
1863 #ifdef __cplusplus
1865 #endif /* cplusplus */
1867 /* The Twain structures must be packed on 2 byte alignment */
1868 #include "poppack.h"
1870 #endif /* TWAIN */