af062818b47340eef15700d2f0211576ba3506eevboxsync/* ======================================================================== *\
af062818b47340eef15700d2f0211576ba3506eevboxsync Copyright (C) 1991, 1992 TWAIN Working Group: Aldus, Caere, Eastman-Kodak,
af062818b47340eef15700d2f0211576ba3506eevboxsync Hewlett-Packard and Logitech Corporations. All rights reserved.
af062818b47340eef15700d2f0211576ba3506eevboxsync Copyright (C) 1997 TWAIN Working Group: Bell+Howell, Canon, DocuMagix,
af062818b47340eef15700d2f0211576ba3506eevboxsync Fujitsu, Genoa Technology, Hewlett-Packard, Kofax Imaging Products, and
af062818b47340eef15700d2f0211576ba3506eevboxsync Ricoh Corporation. All rights reserved.
af062818b47340eef15700d2f0211576ba3506eevboxsync Copyright (C) 1998 TWAIN Working Group: Adobe Systems Incorporated,
af062818b47340eef15700d2f0211576ba3506eevboxsync Canon Information Systems, Eastman Kodak Company,
af062818b47340eef15700d2f0211576ba3506eevboxsync Fujitsu Computer Products of America, Genoa Technology,
af062818b47340eef15700d2f0211576ba3506eevboxsync Hewlett-Packard Company, Intel Corporation, Kofax Image Products,
af062818b47340eef15700d2f0211576ba3506eevboxsync JFL Peripheral Solutions Inc., Ricoh Corporation, and Xerox Corporation.
af062818b47340eef15700d2f0211576ba3506eevboxsync All rights reserved.
af062818b47340eef15700d2f0211576ba3506eevboxsync TWAIN.h - This is the definitive include file for applications and
af062818b47340eef15700d2f0211576ba3506eevboxsync data sources written to the TWAIN specification.
af062818b47340eef15700d2f0211576ba3506eevboxsync It defines constants, data structures, messages etc.
af062818b47340eef15700d2f0211576ba3506eevboxsync for the public interface to TWAIN.
af062818b47340eef15700d2f0211576ba3506eevboxsync Revision History:
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.0, March 6, 1992. TWAIN 1.0.
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.1, January 1993. Tech Notes 1.1
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.5, June 1993. Specification Update 1.5
af062818b47340eef15700d2f0211576ba3506eevboxsync Change DC to TW
af062818b47340eef15700d2f0211576ba3506eevboxsync Change filename from DC.H to TWAIN.H
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.5, July 1993. Remove spaces from country identifiers
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.7, July 1997 Added Capabilities and data structure for
af062818b47340eef15700d2f0211576ba3506eevboxsync document imaging and digital cameras.
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.7, July 1997 Inserted Borland compatible structure packing
af062818b47340eef15700d2f0211576ba3506eevboxsync directives provided by Mentor. JMH
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.7, Aug 1997 Expanded file tabs to spaces.
af062818b47340eef15700d2f0211576ba3506eevboxsync NOTE: future authors should be sure to have
af062818b47340eef15700d2f0211576ba3506eevboxsync their editors set to automatically expand tabs
af062818b47340eef15700d2f0211576ba3506eevboxsync to spaces (original tab setting was 4 spaces).
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.7, Sept 1997 Added job control values
af062818b47340eef15700d2f0211576ba3506eevboxsync Added return codes
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.7, Sept 1997 changed definition of pRGBRESPONSE to
af062818b47340eef15700d2f0211576ba3506eevboxsync pTW_RGBRESPONSE
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.7 Aug 1998 Added missing TWEI_BARCODEROTATION values
af062818b47340eef15700d2f0211576ba3506eevboxsync TWBCOR_ types JMH
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.8 August 1998 Added new types and definitions required
af062818b47340eef15700d2f0211576ba3506eevboxsync for 1.8 Specification JMH
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.8 January 1999 Changed search mode from SRCH_ to TWBD_ as
af062818b47340eef15700d2f0211576ba3506eevboxsync in 1.8 Specification, added TWBT_MAXICODE JMH
af062818b47340eef15700d2f0211576ba3506eevboxsync version 1.8 January 1999 Removed undocumented duplicate AUTO<cap> JMH
af062818b47340eef15700d2f0211576ba3506eevboxsync\* ======================================================================== */
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync * Sun LGPL Disclaimer: For the avoidance of doubt, except that if any license choice
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync * other than GPL or LGPL is available it will apply instead, Sun elects to use only
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync * the Lesser General Public License version 2.1 (LGPLv2) at this time for any software where
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync * a choice of LGPL license versions is made available with the language indicating
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync * that LGPLv2 or any later version may be used, or where a choice of which version
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync * of the LGPL is applied is otherwise unspecified.
af062818b47340eef15700d2f0211576ba3506eevboxsync/* The Twain structures must be packed on 2 byte alignment */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * TWAIN Version *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWON_PROTOCOLMINOR 8 /* Changed for Version 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Platform Dependent Definitions and Typedefs *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Define one of the following, depending on the platform */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* #define _MAC_ */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* #define _UNIX_ */
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* _MSWIN_ */
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* _MAC_ */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* #define PASCAL pascal */
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* _UNIX_ */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Type Definitions *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* String types. These include room for the strings and a NULL char, *
af062818b47340eef15700d2f0211576ba3506eevboxsync * or, on the Mac, a length byte followed by the string. *
af062818b47340eef15700d2f0211576ba3506eevboxsync * TW_STR255 must hold less than 256 chars so length fits in first byte. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Numeric types. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Fixed point structure type. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Structure Definitions *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* No DAT needed. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* No DAT needed. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* No DAT needed. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT8 Index; /* Value used to index into the color table. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT8 Channel1; /* First tri-stimulus value (e.g Red) */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT8 Channel2; /* Second tri-stimulus value (e.g Green) */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT8 Channel3; /* Third tri-stimulus value (e.g Blue) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* No DAT. Defines a frame rectangle in ICAP_UNITS coordinates. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* No DAT needed. Used to manage memory buffers. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 Flags; /* Any combination of the TWMF_ constants. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 Length; /* Number of bytes stored in buffer TheMem. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_MEMREF TheMem; /* Pointer or handle to the allocated memory buffer. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* No DAT needed. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* No DAT needed. Describes version of software currently running. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 MajorNum; /* Major revision number of the software. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 MinorNum; /* Incremental revision number of the software. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* TWON_ARRAY. Container for array of values (a simplified TW_ENUMERATION) */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 NumItems; /* How many items in ItemList */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT8 ItemList[1]; /* Array of ItemType values starts here */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* TWON_ENUMERATION. Container for a collection of values. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 NumItems; /* How many items in ItemList */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 CurrentIndex; /* Current value is in ItemList[CurrentIndex] */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 DefaultIndex; /* Powerup value is in ItemList[DefaultIndex] */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT8 ItemList[1]; /* Array of ItemType values starts here */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* TWON_ONEVALUE. Container for one value. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* TWON_RANGE. Container for a range of values. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 MinValue; /* Starting value in the range. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 MaxValue; /* Final value in the range. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 StepSize; /* Increment from MinValue to MaxValue. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 CurrentValue; /* The value that is currently in effect. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_CAPABILITY. Used by application to get/set capability from/in a data source. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 Cap; /* id of capability to set or get, e.g. CAP_BRIGHTNESS */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 ConType; /* TWON_ONEVALUE, _RANGE, _ENUMERATION or _ARRAY */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_HANDLE hContainer; /* Handle to container of type Dat */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_CIECOLOR. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_EVENT. For passing events down from the application to the DS. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_MEMREF pEvent; /* Windows pMSG or Mac pEvent. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 TWMessage; /* TW msg from data source, e.g. MSG_XFERREADY */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_GRAYRESPONSE */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_IDENTITY. Identifies the program/library/code resource. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 Id; /* Unique number. In Windows, application hWnd */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_VERSION Version; /* Identifies the piece of code */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 ProtocolMajor; /* Application and DS must set to TWON_PROTOCOLMAJOR */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 ProtocolMinor; /* Application and DS must set to TWON_PROTOCOLMINOR */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 SupportedGroups; /* Bit field OR combination of DG_ constants */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_STR32 Manufacturer; /* Manufacturer name, e.g. "Hewlett-Packard" */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_STR32 ProductFamily; /* Product family name, e.g. "ScanJet" */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_STR32 ProductName; /* Product name, e.g. "ScanJet Plus" */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_IMAGEINFO. Application gets detailed image info from DS with this. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_FIX32 XResolution; /* Resolution in the horizontal */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_FIX32 YResolution; /* Resolution in the vertical */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT32 ImageWidth; /* Columns in the image, -1 if unknown by DS*/
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT32 ImageLength; /* Rows in the image, -1 if unknown by DS */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT16 SamplesPerPixel; /* Number of samples per pixel, 3 for RGB */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT16 BitsPerSample[8]; /* Number of bits for each sample */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT16 BitsPerPixel; /* Number of bits for each padded pixel */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_BOOL Planar; /* True if Planar, False if chunky */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT16 PixelType; /* How to interp data; photo interp (TWPT_) */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 Compression; /* How the data is compressed (TWCP_xxxx) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_IMAGELAYOUT. Provides image layout information in current units. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_FRAME Frame; /* Frame coords within larger document */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 PageNumber; /* Reset when you go to next document */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 FrameNumber; /* Reset when you go to next page */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_IMAGEMEMXFER. Used to pass image data (e.g. in strips) from DS to application.*/
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 Compression; /* How the data is compressed */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 BytesPerRow; /* Number of bytes in a row of data */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 XOffset; /* How far from the side of the image */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 YOffset; /* How far from the top of the image */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 BytesWritten; /* How many bytes written in Memory */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_MEMORY Memory; /* Mem struct used to pass actual image data */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Changed in 1.1: QuantTable, HuffmanDC, HuffmanAC TW_MEMREF -> TW_MEMORY */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_JPEGCOMPRESSION. Based on JPEG Draft International Std, ver 10918-1. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 ColorSpace; /* One of the TWPT_xxxx values */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 SubSampling; /* Two word "array" for subsampling values */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 NumComponents; /* Number of color components in image */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 RestartFrequency; /* Frequency of restart marker codes in MDU's */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 QuantMap[4]; /* Mapping of components to QuantTables */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 HuffmanMap[4]; /* Mapping of components to Huffman tables */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_PALETTE8. Color palette when TWPT_PALETTE pixels xfer'd in mem buf. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 NumColors; /* Number of colors in the color table. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 PaletteType; /* TWPA_xxxx, specifies type of palette. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_ELEMENT8 Colors[256]; /* Array of palette values starts here. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_PENDINGXFERS. Used with MSG_ENDXFER to indicate additional data. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_RGBRESPONSE */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_SETUPFILEXFER. Sets up DS to application data transfer via a file. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_SETUPMEMXFER. Sets up DS to application data transfer via a memory buffer. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_STATUS. Application gets detailed status info from a data source with this. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_USERINTERFACE. Coordinates UI between application and data source. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_BOOL ShowUI; /* TRUE if DS should bring up its UI */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_BOOL ModalUI; /* For Mac only - true if the DS's UI is modal */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_HANDLE hParent; /* For windows only - Application window handle */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* SDH - 03/21/95 - TWUNK */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_TWUNKIDENTITY. Provides DS identity and 'other' information necessary */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* across thunk link. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_IDENTITY identity; /* Identity of data source. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_STR255 dsPath; /* Full path and file name of data source. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* SDH - 03/21/95 - TWUNK */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Provides DS_Entry parameters over thunk link. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_IDENTITY dest; /* Identity of data source (if used) */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT32 dataGroup; /* DSM_Entry dataGroup parameter */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT16 dataArgType; /* DSM_Entry dataArgType parameter */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT16 message; /* DSM_Entry message parameter */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT32 pDataSize; /* Size of pData (0 if NULL) */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* TW_MEMREF pData; */ /* Based on implementation specifics, a */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* pData parameter makes no sense in this */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* structure, but data (if provided) will be*/
af062818b47340eef15700d2f0211576ba3506eevboxsync /* appended in the data block. */
af062818b47340eef15700d2f0211576ba3506eevboxsync } TW_TWUNKDSENTRYPARAMS, FAR * pTW_TWUNKDSENTRYPARAMS;
af062818b47340eef15700d2f0211576ba3506eevboxsync/* SDH - 03/21/95 - TWUNK */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Provides DS_Entry results over thunk link. */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 returnCode; /* Thunker DsEntry return code. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 conditionCode; /* Thunker DsEntry condition code. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT32 pDataSize; /* Size of pData (0 if NULL) */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* TW_MEMREF pData; */ /* Based on implementation specifics, a */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* pData parameter makes no sense in this */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* structure, but data (if provided) will be*/
af062818b47340eef15700d2f0211576ba3506eevboxsync /* appended in the data block. */
af062818b47340eef15700d2f0211576ba3506eevboxsync} TW_TWUNKDSENTRYRETURN, FAR * pTW_TWUNKDSENTRYRETURN;
af062818b47340eef15700d2f0211576ba3506eevboxsync/* WJD - 950818 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added for 1.6 Specification */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* TWAIN 1.6 CAP_SUPPORTEDCAPSEXT structure */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 Cap; /* Which CAP/ICAP info is relevant to */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 Properties; /* Messages this CAP/ICAP supports */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ----------------------------------------------------------------------- *\
af062818b47340eef15700d2f0211576ba3506eevboxsync Version 1.7: Added Following data structure for Document Imaging
af062818b47340eef15700d2f0211576ba3506eevboxsync July 1997 Enhancement.
af062818b47340eef15700d2f0211576ba3506eevboxsync KHL TW_CUSTOMDSDATA -- For Saving and Restoring Source's
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INFO -- Each attribute for extended image
af062818b47340eef15700d2f0211576ba3506eevboxsync information.
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_EXTIMAGEINFO -- Extended image information structure.
af062818b47340eef15700d2f0211576ba3506eevboxsync\* ----------------------------------------------------------------------- */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 InfoLength; /* Length of Information in bytes. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_HANDLE hData; /* Place holder for data, DS Allocates */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_AUDIOINFO, information about audio data */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_DEVICEEVENT, information about events */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 Event; /* One of the TWDE_xxxx values. */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_STR255 DeviceName; /* The name of the device that generated the event */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 BatteryMinutes; /* Battery Minutes Remaining */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT16 BatteryPercentage; /* Battery Percentage Remaining */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 AutomaticCapture; /* Automatic Capture */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 TimeBeforeFirstCapture; /* Automatic Capture */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 TimeBetweenCaptures; /* Automatic Capture */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_FILESYSTEM, information about TWAIN file system */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync /* DG_CONTROL / DAT_FILESYSTEM / MSG_xxxx fields */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_STR255 InputName; /* The name of the input or source file */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_STR255 OutputName; /* The result of an operation or the name of a destination file */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_MEMREF Context; /* Source specific data used to remember state information */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* DG_CONTROL / DAT_FILESYSTEM / MSG_DELETE field */
af062818b47340eef15700d2f0211576ba3506eevboxsync int Recursive; /* recursively delete all sub-directories */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* DG_CONTROL / DAT_FILESYSTEM / MSG_GETINFO fields */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT32 FileType; /* One of the TWFT_xxxx values */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_STR32 CreateTimeDate; /* creation date of the file */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_STR32 ModifiedTimeDate; /* last date the file was modified */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 FreeSpace; /* bytes of free space on the current device */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT32 NewImageSize; /* estimate of the amount of space a new image would take up */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 NumberOfFiles; /* number of files, depends on FileType */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_PASSTHRU, device dependent data to pass through Data Source */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_MEMREF pCommand; /* Pointer to Command buffer */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 CommandBytes; /* Number of bytes in Command buffer */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_INT32 Direction; /* One of the TWDR_xxxx values. Defines the direction of data flow */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 DataBytes; /* Number of bytes in Data buffer */
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 DataBytesXfered; /* Number of bytes successfully transferred */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* DAT_SETUPAUDIOFILEXFER, information required to setup an audio file transfer */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct {
af062818b47340eef15700d2f0211576ba3506eevboxsync} TW_SETUPAUDIOFILEXFER, FAR * pTW_SETUPAUDIOFILEXFER;
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Generic Constants *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWON_ARRAY 3 /* indicates TW_ARRAY container */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWON_ENUMERATION 4 /* indicates TW_ENUMERATION container */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWON_ONEVALUE 5 /* indicates TW_ONEVALUE container */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWON_RANGE 6 /* indicates TW_RANGE container */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWON_ICONID 962 /* res Id of icon used in USERSELECT lbox */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWON_DSMID 461 /* res Id of the DSM version num resource */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWON_DSMCODEID 63 /* res Id of the Mac SM Code resource */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Flags used in TW_MEMORY structure. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Palette types for TW_PALETTE8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* There are four containers used for capabilities negotiation:
af062818b47340eef15700d2f0211576ba3506eevboxsync * TWON_ONEVALUE, TWON_RANGE, TWON_ENUMERATION, TWON_ARRAY
af062818b47340eef15700d2f0211576ba3506eevboxsync * In each container structure ItemType can be TWTY_INT8, TWTY_INT16, etc.
af062818b47340eef15700d2f0211576ba3506eevboxsync * The kind of data stored in the container can be determined by doing
af062818b47340eef15700d2f0211576ba3506eevboxsync * DCItemSize[ItemType] where the following is defined in TWAIN glue code:
af062818b47340eef15700d2f0211576ba3506eevboxsync * DCItemSize[]= { sizeof(TW_INT8),
af062818b47340eef15700d2f0211576ba3506eevboxsync * sizeof(TW_INT16),
af062818b47340eef15700d2f0211576ba3506eevboxsync * sizeof(TW_UINT32) };
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_INT8 0x0000 /* Means Item is a TW_INT8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_INT16 0x0001 /* Means Item is a TW_INT16 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_INT32 0x0002 /* Means Item is a TW_INT32 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_UINT8 0x0003 /* Means Item is a TW_UINT8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_UINT16 0x0004 /* Means Item is a TW_UINT16 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_UINT32 0x0005 /* Means Item is a TW_UINT32 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_BOOL 0x0006 /* Means Item is a TW_BOOL */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_FIX32 0x0007 /* Means Item is a TW_FIX32 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_FRAME 0x0008 /* Means Item is a TW_FRAME */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_STR32 0x0009 /* Means Item is a TW_STR32 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_STR64 0x000a /* Means Item is a TW_STR64 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_STR128 0x000b /* Means Item is a TW_STR128 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWTY_STR255 0x000c /* Means Item is a TW_STR255 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Capability Constants *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_BITORDER values (BO_ means Bit Order) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_COMPRESSION values (CP_ means ComPression ) */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCP_GROUP31D 2 /* Follows CCITT spec (no End Of Line) */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCP_GROUP31DEOL 3 /* Follows CCITT spec (has End Of Line) */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCP_GROUP32D 4 /* Follows CCITT spec (use cap for K Factor) */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCP_JPEG 6 /* Use capability for more info */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCP_LZW 7 /* Must license from Unisys and IBM to use */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCP_JBIG 8 /* For Bitonal images -- Added 1.7 KHL */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_IMAGEFILEFORMAT values (FF_means File Format) */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWFF_JFIF 4 /* JPEG File Interchange Format */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_FILTER values (FT_ means Filter Type) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_LIGHTPATH values (LP_ means Light Path) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_LIGHTSOURCE values (LS_ means Light Source) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_ORIENTATION values (OR_ means ORientation) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_PLANARCHUNKY values (PC_ means Planar/Chunky ) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_PIXELFLAVOR values (PF_ means Pixel Flavor) */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWPF_CHOCOLATE 0 /* zero pixel represents darkest shade */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWPF_VANILLA 1 /* zero pixel represents lightest shade */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_PIXELTYPE values (PT_ means Pixel Type) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_SUPPORTEDSIZES values (SS_ means Supported Sizes) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.5 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/*#define TWSS_B 8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.7 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_XFERMECH values (SX_ means Setup XFer) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_UNITS values (UN_ means UNits) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.5 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_BITDEPTHREDUCTION values (BR_ means Bitdepth Reduction) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.7 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_DUPLEX values */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.7 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* TWEI_BARCODETYPE values */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.7 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* TWEI_DESKEWSTATUS values */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.7 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* TWEI_PATCHCODE values */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.7 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* CAP_JOBCONTROL values */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.7 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* TWEI_BARCODEROTATION values (BCOR_ means barcode rotation) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ACAP_AUDIOFILEFORMAT values (AF_ means audio format) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* CAP_ALARMS values (AL_ means alarms) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* CAP_CLEARBUFFERS values (CB_ means clear buffers) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* CAP_DEVICEEVENT values (DE_ means device event) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* CAP_FEEDERALIGNMENT values (FA_ means feeder alignment) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* CAP_FEEDERORDER values (FO_ means feeder order) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* CAP_FILESYSTEM values (FS_ means file system) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* CAP_POWERSUPPLY values (PS_ means power supply) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* CAP_PRINTER values (PR_ means printer) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* CAP_PRINTERMODE values (PM_ means printer mode) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_BARCODESEARCHMODE values (TWBD_ means search) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_FLASHUSED2 values (FL_ means flash) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_FLIPROTATION values (FR_ means flip rotation) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_IMAGEFILTER values (IF_ means image filter) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_NOISEFILTER values (NF_ means noise filter) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ICAP_OVERSCAN values (OV_ means overscan) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* TW_FILESYSTEM.FileType values (FT_ means file type) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Country Constants *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added for 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Language Constants *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added for 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWLG_ARABIC_UAE 31 /* United Arabic Emirates */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWLG_CHINESE_PRC 39 /* People's Republic of China */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* More stuff added for 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Data Groups *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* More Data Groups may be added in the future.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Possible candidates include text, vector graphics, sound, etc.
af062818b47340eef15700d2f0211576ba3506eevboxsync * NOTE: Data Group constants must be powers of 2 as they are used
af062818b47340eef15700d2f0211576ba3506eevboxsync * as bitflags when Application asks DSM to present a list of DSs.
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DG_CONTROL 0x0001L /* data pertaining to control */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DG_IMAGE 0x0002L /* data pertaining to raster images */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DG_AUDIO 0x0004L /* data pertaining to audio */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Data Argument Types *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* SDH - 03/23/95 - WATCH */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* The thunker requires knowledge about size of data being passed in the */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* lpData parameter to DS_Entry (which is not readily available due to */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* type LPVOID. Thus, we key off the DAT_ argument to determine the size. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* This has a couple implications: */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* 1) Any additional DAT_ features require modifications to the thunk code */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* for thunker support. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* 2) Any applications which use the custom capabilities are not supported */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* under thunking since we have no way of knowing what size data (if */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* any) is being passed. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_CUSTOMBASE 0x8000 /* Base of custom DATs. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Data Argument Types for the DG_CONTROL Data Group. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_PARENT 0x0004 /* TW_HANDLE, application win handle in Windows */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_PENDINGXFERS 0x0005 /* TW_PENDINGXFERS */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_SETUPMEMXFER 0x0006 /* TW_SETUPMEMXFER */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_SETUPFILEXFER 0x0007 /* TW_SETUPFILEXFER */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_USERINTERFACE 0x0009 /* TW_USERINTERFACE */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* SDH - 03/21/95 - TWUNK */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Additional message required for thunker to request the special */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* identity information. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_TWUNKIDENTITY 0x000b /* TW_TWUNKIDENTITY */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_CUSTOMDSDATA 0x000c /* TW_CUSTOMDSDATA. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Data Argument Types for the DG_IMAGE Data Group. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_IMAGEMEMXFER 0x0103 /* TW_IMAGEMEMXFER */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_IMAGENATIVEXFER 0x0104 /* TW_UINT32 loword is hDIB, PICHandle */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_GRAYRESPONSE 0x0107 /* TW_GRAYRESPONSE */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_JPEGCOMPRESSION 0x0109 /* TW_JPEGCOMPRESSION */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_EXTIMAGEINFO 0x010b /* TW_EXTIMAGEINFO -- for 1.7 Spec. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Data Argument Types for the DG_AUDIO Data Group. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define DAT_AUDIONATIVEXFER 0x0203 /* TW_UINT32 handle to WAV, (AIFF Mac) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Messages *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* All message constants are unique.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Messages are grouped according to which DATs they are used with.*/
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_NULL 0x0000 /* Used in TW_EVENT structure */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_CUSTOMBASE 0x8000 /* Base of custom messages */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Generic messages may be used with any of several DATs. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_GETCURRENT 0x0002 /* Get current value */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_GETDEFAULT 0x0003 /* Get default (e.g. power up) value */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_GETFIRST 0x0004 /* Get first of a series of items, e.g. DSs */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_GETNEXT 0x0005 /* Iterate through a series of items. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_RESET 0x0007 /* Set current value to default value */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_QUERYSUPPORT 0x0008 /* Get supported operations on the cap. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Messages used with DAT_NULL */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_XFERREADY 0x0101 /* The data source has data ready */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_CLOSEDSREQ 0x0102 /* Request for Application. to close DS */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_CLOSEDSOK 0x0103 /* Tell the Application. to save the state. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_DEVICEEVENT 0X0104 /* Some event has taken place */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Messages used with a pointer to a DAT_STATUS structure */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_CHECKSTATUS 0x0201 /* Get status information */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Messages used with a pointer to DAT_PARENT data */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Messages used with a pointer to a DAT_IDENTITY structure */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_CLOSEDS 0x0402 /* Close a data source */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_USERSELECT 0x0403 /* Put up a dialog of all DS */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Messages used with a pointer to a DAT_USERINTERFACE structure */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_DISABLEDS 0x0501 /* Disable data transfer in the DS */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_ENABLEDS 0x0502 /* Enable data transfer in the DS */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define MSG_ENABLEDSUIONLY 0x0503 /* Enable for saving DS state only. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Messages used with a pointer to a DAT_EVENT structure */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Messages used with a pointer to a DAT_PENDINGXFERS structure */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Messages used with a pointer to a DAT_FILESYSTEM structure */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Messages used with a pointer to a DAT_PASSTHRU structure */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Capabilities *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync#define CAP_CUSTOMBASE 0x8000 /* Base of custom capabilities */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* all data sources are REQUIRED to support these caps */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* image data sources are REQUIRED to support these caps */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_UNITS 0x0102 /* default is TWUN_INCHES */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* all data sources MAY support these caps */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define CAP_THUMBNAILSENABLED 0x1011 /* Added 1.7 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define CAP_TIMEBEFOREFIRSTCAPTURE 0x101b /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define CAP_TIMEBETWEENCAPTURES 0x101c /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define CAP_PAGEMULTIPLEACQUIRE 0x1023 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define CAP_BATTERYPERCENTAGE 0x1033 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* image data sources MAY support these caps */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_BITDEPTHREDUCTION 0x112c /* Added 1.5 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_UNDEFINEDIMAGESIZE 0x112d /* Added 1.6 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_AUTODISCARDBLANKPAGES 0x1134 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_BARCODEDETECTIONENABLED 0x1137 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_SUPPORTEDBARCODETYPES 0x1138 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_BARCODEMAXSEARCHPRIORITIES 0x1139 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_BARCODESEARCHPRIORITIES 0x113a /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_BARCODESEARCHMODE 0x113b /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_BARCODEMAXRETRIES 0x113c /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_PATCHCODEDETECTIONENABLED 0x113f /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_SUPPORTEDPATCHCODETYPES 0x1140 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_PATCHCODEMAXSEARCHPRIORITIES 0x1141 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_PATCHCODESEARCHPRIORITIES 0x1142 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_PATCHCODESEARCHMODE 0x1143 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_PATCHCODEMAXRETRIES 0x1144 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_PATCHCODETIMEOUT 0x1145 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define ICAP_AUTOMATICBORDERDETECTION 0x1150 /* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* image data sources MAY support these audio caps */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* ----------------------------------------------------------------------- *\
af062818b47340eef15700d2f0211576ba3506eevboxsync Version 1.7: Following is Extended Image Info Attributes.
af062818b47340eef15700d2f0211576ba3506eevboxsync\* ----------------------------------------------------------------------- */
af062818b47340eef15700d2f0211576ba3506eevboxsync/***************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Return Codes and Condition Codes section *
af062818b47340eef15700d2f0211576ba3506eevboxsync ***************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Return Codes: DSM_Entry and DS_Entry may return any one of these values. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWRC_FAILURE 1 /* Application may get TW_STATUS for info on failure */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWRC_CHECKSTATUS 2 /* "tried hard"; get status */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWRC_ENDOFLIST 7 /* After MSG_GETNEXT if nothing left */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Condition Codes: Application gets these by doing DG_CONTROL DAT_STATUS MSG_GET. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_BUMMER 1 /* Failure due to unknown causes */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_LOWMEMORY 2 /* Not enough memory to perform operation */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_MAXCONNECTIONS 4 /* DS is connected to max possible applications */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_OPERATIONERROR 5 /* DS or DSM reported error, application shouldn't */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_BADPROTOCOL 9 /* Unrecognized MSG DG DAT combination */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_BADVALUE 10 /* Data parameter out of range */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_SEQERROR 11 /* DG DAT MSG out of expected sequence */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_BADDEST 12 /* Unknown destination Application/Source in DSM_Entry */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_CAPUNSUPPORTED 13 /* Capability not supported by source */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_CAPBADOPERATION 14 /* Operation not supported by capability */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_CAPSEQERROR 15 /* Capability has dependency on other capability */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.8 */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_DENIED 16 /* File System operation is denied (file is protected) */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_FILEEXISTS 17 /* Operation failed because file already exists. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_NOTEMPTY 19 /* Operation failed because directory is not empty */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_PAPERDOUBLEFEED 21 /* The feeder detected multiple pages */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_FILEWRITEERROR 22 /* Error writing the file (meant for things like disk full conditions) */
af062818b47340eef15700d2f0211576ba3506eevboxsync#define TWCC_CHECKDEVICEONLINE 23 /* The device went offline prior to or during this operation */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* bit patterns: for query the operation that are supported by the data source on a capability */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Application gets these through DG_CONTROL/DAT_CAPABILITY/MSG_QUERYSUPPORT */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Added 1.6 */
af062818b47340eef15700d2f0211576ba3506eevboxsync/****************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Entry Points *
af062818b47340eef15700d2f0211576ba3506eevboxsync ****************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/**********************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Function: DSM_Entry, the only entry point into the Data Source Manager.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Parameters:
af062818b47340eef15700d2f0211576ba3506eevboxsync * pOrigin Identifies the source module of the message. This could
af062818b47340eef15700d2f0211576ba3506eevboxsync * identify an Application, a Source, or the Source Manager.
af062818b47340eef15700d2f0211576ba3506eevboxsync * pDest Identifies the destination module for the message.
af062818b47340eef15700d2f0211576ba3506eevboxsync * This could identify an application or a data source.
af062818b47340eef15700d2f0211576ba3506eevboxsync * If this is NULL, the message goes to the Source Manager.
af062818b47340eef15700d2f0211576ba3506eevboxsync * DG The Data Group.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Example: DG_IMAGE.
af062818b47340eef15700d2f0211576ba3506eevboxsync * DAT The Data Attribute Type.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Example: DAT_IMAGEMEMXFER.
af062818b47340eef15700d2f0211576ba3506eevboxsync * MSG The message. Messages are interpreted by the destination module
af062818b47340eef15700d2f0211576ba3506eevboxsync * with respect to the Data Group and the Data Attribute Type.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Example: MSG_GET.
af062818b47340eef15700d2f0211576ba3506eevboxsync * pData A pointer to the data structure or variable identified
af062818b47340eef15700d2f0211576ba3506eevboxsync * by the Data Attribute Type.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Example: (TW_MEMREF)&ImageMemXfer
af062818b47340eef15700d2f0211576ba3506eevboxsync * where ImageMemXfer is a TW_IMAGEMEMXFER structure.
af062818b47340eef15700d2f0211576ba3506eevboxsync * ReturnCode
af062818b47340eef15700d2f0211576ba3506eevboxsync * Example: TWRC_SUCCESS.
af062818b47340eef15700d2f0211576ba3506eevboxsync ********************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Don't mangle the name "DSM_Entry" if we're compiling in C++! */
af062818b47340eef15700d2f0211576ba3506eevboxsyncextern "C" {
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* __cplusplus */
af062818b47340eef15700d2f0211576ba3506eevboxsyncTW_UINT16 FAR PASCAL DSM_Entry( pTW_IDENTITY pOrigin,
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef TW_UINT16 (FAR PASCAL *DSMENTRYPROC)(pTW_IDENTITY, pTW_IDENTITY,
af062818b47340eef15700d2f0211576ba3506eevboxsync#else /* _MSWIN_ */
af062818b47340eef15700d2f0211576ba3506eevboxsync/*FAR PASCAL TW_UINT16 DSM_Entry( pTW_IDENTITY pOrigin,
af062818b47340eef15700d2f0211576ba3506eevboxsync pTW_IDENTITY pDest,
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 DG,
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 DAT,
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 MSG,
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_MEMREF pData);*/
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef TW_UINT16 (*DSMENTRYPROC)(pTW_IDENTITY, pTW_IDENTITY,
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* _MSWIN_ */
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* cplusplus */
af062818b47340eef15700d2f0211576ba3506eevboxsync/**********************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync * Function: DS_Entry, the entry point provided by a Data Source.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Parameters:
af062818b47340eef15700d2f0211576ba3506eevboxsync * pOrigin Identifies the source module of the message. This could
af062818b47340eef15700d2f0211576ba3506eevboxsync * identify an application or the Data Source Manager.
af062818b47340eef15700d2f0211576ba3506eevboxsync * DG The Data Group.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Example: DG_IMAGE.
af062818b47340eef15700d2f0211576ba3506eevboxsync * DAT The Data Attribute Type.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Example: DAT_IMAGEMEMXFER.
af062818b47340eef15700d2f0211576ba3506eevboxsync * MSG The message. Messages are interpreted by the data source
af062818b47340eef15700d2f0211576ba3506eevboxsync * with respect to the Data Group and the Data Attribute Type.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Example: MSG_GET.
af062818b47340eef15700d2f0211576ba3506eevboxsync * pData A pointer to the data structure or variable identified
af062818b47340eef15700d2f0211576ba3506eevboxsync * by the Data Attribute Type.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Example: (TW_MEMREF)&ImageMemXfer
af062818b47340eef15700d2f0211576ba3506eevboxsync * where ImageMemXfer is a TW_IMAGEMEMXFER structure.
af062818b47340eef15700d2f0211576ba3506eevboxsync * ReturnCode
af062818b47340eef15700d2f0211576ba3506eevboxsync * Example: TWRC_SUCCESS.
af062818b47340eef15700d2f0211576ba3506eevboxsync * The DSPROC type is only used by an application when it calls
af062818b47340eef15700d2f0211576ba3506eevboxsync * a Data Source directly, bypassing the Data Source Manager.
af062818b47340eef15700d2f0211576ba3506eevboxsync ********************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Don't mangle the name "DS_Entry" if we're compiling in C++! */
af062818b47340eef15700d2f0211576ba3506eevboxsyncextern "C" {
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* __cplusplus */
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync TW_UINT16 DECLSPEC_EXPORT PASCAL DS_Entry (pTW_IDENTITY pOrigin,
af062818b47340eef15700d2f0211576ba3506eevboxsync typedef TW_UINT16 (FAR PASCAL *DSENTRYPROC) (pTW_IDENTITY pOrigin,
af062818b47340eef15700d2f0211576ba3506eevboxsync#else /* _MSWIN_ */
af062818b47340eef15700d2f0211576ba3506eevboxsync/*FAR PASCAL TW_UINT16 DS_Entry( pTW_IDENTITY pOrigin,
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT32 DG,
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 DAT,
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_UINT16 MSG,
af062818b47340eef15700d2f0211576ba3506eevboxsync TW_MEMREF pData);*/
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* _MSWIN_ */
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* cplusplus */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* The Twain structures must be packed on 2 byte alignment */
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* TWAIN */