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