Kodak KDS TWAIN Driver
TWAIN interface
21-January-2013
Contents
Capabilities and descriptions are color coded for clarity:
|
GREEN |
Full support |
|
PURPLE |
Kodak Custom |
|
RED |
Unsupported |
Values are specified with units (in most cases inches). If changing ICAP_UNITS, the allowed values change accordingly.
1. DG_CONTROL
DAT_CAPABILITY Full support.
DAT_COLORTABLEMAP Custom: All Models (except for i2000/i2900/i3000/i4000/i5000).
- This will allows an application to map the ICAP_COLORTABLE numeric values to both the English and current language strings.
- The value of 0xFFFF for ColorTableValue indicates the end of the array.
- Only MSG_GET, MSG_GETCURRENT and MSG_GETDEFAULT are supported.
DAT_CUSTOMDSDATA Full support.
- Data is Source specific, applications must not parse it.
DAT_DEVICEEVENT Full support
DAT_DEVICEINFO Custom: All Models
- This provides additional information about the device that may be useful with some system message, such as WM_DEVICECHANGE.
- The dwFields value indicates how many fields are supported by the driver (the value doesn't include the dwFields, itself).
- Only MSG_GET, MSG_GETCURRENT and MSG_GETDEFAULT are supported.
DAT_ECDO Custom: i900/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
- This will allows an application to map the ICAP_ECDO numeric values to both the English and current language strings.
- The value of 0xFFFF for EcdoValue indicates the end of the array.
- Only MSG_GET, MSG_GETCURRENT and MSG_GETDEFAULT are supported.
DAT_EVENT Full support.
DAT_FILESYSTEM Supports 'camera' devices.
Default: /Camera_Bitonal_Both
- The following devices are supported, depending on the scanner model:
/Camera_Bitonal_Both
/Camera_Bitonal_Top
/Camera_Bitonal_Bottom
/Camera_Color_Both
/Camera_Color_Top
/Camera_Color_Bottom
- Image storage is not supported.
DAT_IDENTITY Full support.
DAT_LOG Custom: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
- Used by an application to collect log information from the scanner.
- Refer to kdscust.h for details about how to use this call.
- Only MSG_GET is supported.
DAT_NULL Full support.
- MSG_CLOSEDSREQ is sent when the Source's Cancel button is pressed.
- MSG_CLOSEDKOK is sent when the Source's OK button is pressed.
- MSG_XFERREADY is sent after the first image is scanned.
- MSG_DEVICEEVENT is supported.
DAT_OCPBUTTONS Custom: i2000/i2900/i3000
-
This feature allows the application to set the displayed text on the OCP for
each button, as well as to indicate which Paper
Source the button will scan from.
- Only MSG_SET is supported.
DAT_PARENT Full support.
- This operation only communicates with the Source Manager.
DAT_PASSTHRU Unsupported
DAT_PENDINGXFERS Full support.
- MSG_STOPFEEDER is a TWAIN 1.9 operation that may be issued in State 6. Use it when you want to stop the transport, but continue transferring any images that are in the device's buffers.
DAT_PROFILES Custom: i600/i700/i900/i1100/i1200/i1300/i1400/i1800/i2000/i2900/i3000/i4000/i5000
- This allows an application to manage profiles.
- These messages are supported for DAT_PROFILES: MSG_GET, MSG_GETCURRENT, MSG_GETDEFAULT, MSG_PROFILECREATE, MSG_PROFILEDELETE,
MSG_PROFILESAVE, MSG_PROFILERENAME, MSG_PROFILERESTORE, MSG_PROFILEEXPORT, MSG_PROFILEIMPORT, MSG_PROFILESET
DAT_SETUPFILEXFER Full support.
- Supports TWFF_BMP, TWFF_TIFF.
- TWFF_JFIF is not supported on 3500/3510/3520/i810/i830.
- TWFF_BMP is not supported for the i600/i700/i800/i1800 Series when ForceAfterburner=1 in the CONST.INI file.
DAT_SETUPMEMXFER Full support.
- The Source uses the MaxBufSize to pre-allocate a scratch buffer, which for the 3000/4000 scanners must exceed the size of the largest image that the application expects to ever scan. The default size is sufficient for this, and should not be changed without consulting Eastman Kodak.
DAT_STATUS Full support.
- In some cases the status is returned by the Source Manager.
DAT_USERINTERFACE Full support.
- For MSG_ENABLEDS the SCAN, STOP and CANCEL buttons are shown.
- For MSG_ENABLEDSUIONLY the OK and CANCEL buttons are shown.
- ShowUI == FALSE is supported (no UI).
- ModalUI == TRUE is supported, but works by issuing an EnableWindow(hParent,FALSE) on the calling application.
- MSG_SETUPDS is a custom command that downloads the current settings to the scanner, but does not initiate a scanning session. The Source remains in state 4. This command has been added to allow application writers to use more than one of the Gemini modes. See also the ForceAcceptMode variable in const.ini, which can be used to disable mode checking by the Source.
- MSG_ENABLESCANNER is a custom command that starts a scanning session without downloading any settings.
DAT_WINDOW Custom: i600/i700/i900/i1100/i1200/i1300/i1400/i1800/i2000/i2900/i3000/i4000/i5000
- This utility allows an application to add and remove windows.
- A window is an index to a set of cameras, such as front_bitonal, front_color.
- Only MSG_ADDWINDOW and MSG_DELETEWINDOW are supported.
DAT_XFERGROUP Full support.
2. DG_IMAGE
DAT_CIECOLOR Unsupported.
DAT_EXTIMAGEINFO Full support.
- Please reference TWAIN_ExtImageInfo.htm for a complete list.
- MSG_GETSPECIAL is a custom feature that allows this command to be issued in state 6, before the image data is transferred, instead of state 7, after it has been transferred.
DAT_GRAYRESPONSE Unsupported.
DAT_IMAGEFILEXFER Full support.
- Supports scan error condition codes (ex: TWCC_PAPERJAM).
DAT_IMAGEINFO Full support.
DAT_IMAGELAYOUT Full support.
- Value is shared with ICAP_FRAMES.
- ICAP_SUPPORTEDSIZES will be set to TWSS_NONE if this operation is used with MSG_SET.
- The image width must at a minimum be on a 16-bit boundary. Color images must have a length that falls on an 8-bit boundary. An application can make these calculations itself when the dimensions are in TWUN_PIXELS units. The Source makes any corrections to the settings (on the application's behalf) just prior to downloading to the device.
- Because converting between ICAP_UNITS can result in loss of resolution, applications are encouraged to use TWUN_PIXELS when getting information, to guarantee that the dimensions of the image are accurately reported.
DAT_IMAGEMEMXFER Full support.
- Applications should use the Preferred value from the DAT_SETUPMEMXFER operation to set the minimum transfer buffer size. Because of the high performance of the scanners, memory transfers must move the entire image in one call to guarantee best throughput.
- Supports scan error condition codes (ex: TWCC_PAPERJAM).
DAT_IMAGENATIVEXFER Full support.
- Applications cannot use native mode transfers for anything other than uncompressed data.
- Native transfers are less efficient than memory transfers, since the Source must rotate the image around the x-axis to match the BITMAP format, and convert RGB to BGR in the case of color data.
- Supports scan error condition codes (ex: TWCC_PAPERJAM).
DAT_JPEGCOMPRESSION Full support.
- Supported for all models (except for 5000/7000/9000).
- TWPT_YUV is the only pixel type supported.
- Chroma and Luma tables may be replaced.
- Huffman tables are reported, but may not be changed.
DAT_PALETTE8 Unsupported.
DAT_RGBRESPONSE Unsupported.
3. DG_CUSTOM
DAT_AUTOCOLORLEARN Custom: i600/i700/i1200/i1300/i1400/i1800/i2000/i2900/i3000/i4000/i5000
- This utility will determine the proper ‘Color Amount’ value to use with the current ‘Color Threshold’ value, in order to save a representative stack of color documents as either color or grayscale images.
- There is no associated TW_AUTOCOLORLEARN, applications should send NULL for the data.
- Only MSG_SET and MSG_RESET are supported.
- This is only available when ICAP_AUTOCOLORCONTENT is set to Custom.
DAT_STATUSRAW Custom: All Models
- This command may be issued at any time. It reports the raw data for the last error status report by scanner.
4. CAP_ Capabilities
ACAP_AUDIOFILEFORMAT Unsupported.
ACAP_XFERMECH Unsupported.
CAP_ALARMS Standard: i600/i700/i800/i1800/i5000
Allowed: TWAL_PATCHCODE
Default: Empty
CAP_ALARMVOLUME Standard: i600/i700
Allowed: 0 - 3
Default: 2
CAP_AUTHOR Standard: All Models (except for i2000/i2900/i3000/i4000/i5000)
Allowed: Any TW_STR128 string
Default: Eastman Kodak Company
CAP_AUTOFEED Standard: All Models
Allowed: TRUE
Default: TRUE
- This capability is read-only.
CAP_AUTOMATICCAPTURE Unsupported.
CAP_AUTOMATICSENSEMEDIUM Standard: i2000/i2900/i3000/i5000
Allowed: FALSE, TRUE
Default: FALSE
- Automatically chooses whether to acquire images from the ADF or from the Flatbed.
CAP_AUTOSCAN Standard: All Models
Allowed: FALSE, TRUE
Default: TRUE
- 3000/4000 supports TRUE for CAP_XFERCOUNT == -1 and FALSE for CAP_XFERCOUNT > 0.
- 5000/7000/9000 only supports TRUE.
- Other offer full supports.
CAP_BACKGROUND Custom: All Models (except for 3000/4000/5000/7000/9000)
Allowed: TWBK_BLACK, TWBK_WHITE
Default: scanner dependent
- Reports what the scanner background was at the time the scanner was started. This capability cannot detect a "hot" change.
- This is a read-only capability except for i4000/i5000. It allows the user to select the color of the imaging background. This can be set differently per side.
CAP_BACKGROUNDFRONT Custom: i100/i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: TWBK_BLACK, TWBK_WHITE
Default: scanner dependent
- Reports what the scanner front background was at the time the scanner was started. This capability cannot detect a "hot" change.
- This is a read-only capability.
CAP_BACKGROUNDREAR Custom: i160/i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: TWBK_BLACK, TWBK_WHITE
Default: scanner dependent
- Reports what the scanner rear background was at the time the scanner was started. This capability cannot detect a "hot" change.
- This is a read-only capability.
CAP_BATCHCOUNT Custom: i800/i1800
Allowed: 0 – 32,767
Default: 0 (disabled)
- Controls the number of batches to be processed before applying the batch end function.
CAP_BATCHENDFUNCTION Custom: i800/i1800
Allowed: TWBE_NONE, TWBE_STOPFEEDER, TWBE_ENDOFJOB, TWBE_NEWBATCH
Default: TWBE_NONE
- Action to be taken when the batch count is complete.
CAP_BATCHLEVEL Custom: i800/i1800
Allowed: TWPL_LEVEL1, TWPL_LEVEL2, TWPL_LEVEL3
Default: TWPL_LEVEL1
- Level used to decrement the batch count.
CAP_BATCHSTARTFUNCTION Custom: i800/i1800
Allowed: TWPL_NONE, TWPL_LEVEL1, TWPL_LEVEL2, TWPL_LEVEL3
Default: TWPL_NONE
- Initial level for the batch.
CAP_BATTERYMINUTES Unsupported.
CAP_BATTERYPERCENTAGE Unsupported.
CAP_BINARIZATION Custom: 3590
Allowed: FALSE, TRUE
Default: FALSE
- For use with Multistream(tm), this field must be set to TRUE to get the TWAIN driver to produce
a bitonal image from the color camera. (see CAP_CAMERAENABLE).
CAP_BLANKPAGE Custom: All Models (except for 3000/4000/5000/7000/9000)
Allowed: TWBP_IMAGE
Default: TWBP_IMAGE
- Blank page detection.
CAP_BLANKPAGEMODE Custom: All Models (except for 3000/4000/5000/7000/9000)
Allowed: TWBM_NONE, TWBM_COMPSIZE, TWBM_CONTENT
Default: TWBM_NONE
- Blank image deletion mode. Not all values are supported on all scanners.
CAP_BLANKPAGECOMPSIZEBW Custom: All Models (except for 3000/4000/5000/7000/9000)
Allowed: 0 - 1000 KB
Default: 0
- Delete Bitonal image if the final size is less than specific number of KB.
- Value needs to be in 1024 increments.
- The front and rear values can be different expect for i30/i40/i55/i65.
- When set to a non-zero value: CAP_BLANKPAGEMODE is automatically set to TWBM_COMPSIZE
If set zero and CAP_BLANKPAGECOMPSIZEBW and CAP_BLANKPAGECOMPSIZERGB are zero,
then CAP_BLANKPAGEMODE is automatically changed to TWBM_NONE.
CAP_BLANKPAGECOMPSIZEGRAY Custom: All Models (except for 3000/4000/5000/7000/9000)
Allowed: 0 - 1000 KB
Default: 0
- Delete Gray image if the final size is less than specific number of KB.
- Value needs to be in 1024 increments.
- The front and rear values can be different except for i30/i40/i55/i65.
- When set to a non-zero value: CAP_BLANKPAGEMODE is automatically set to TWBM_COMPSIZE
If set zero and CAP_BLANKPAGECOMPSIZEBW and CAP_BLANKPAGECOMPSIZERGB are zero,
then CAP_BLANKPAGEMODE is automatically changed to TWBM_NONE.
CAP_BLANKPAGECOMPSIZERGB Custom: All Models (except for 3000/4000/5000/7000/9000)
Allowed: 0 - 1000 KB
Default: 0
- Delete Color image if the final size is less than specific number of KB.
- Value needs to be in 1024 increments.
- The front and rear values can be different except for i30/i40/i55/i65.
- When set to a non-zero value: CAP_BLANKPAGEMODE is automatically set to TWBM_COMPSIZE
If set zero and CAP_BLANKPAGECOMPSIZEBW and CAP_BLANKPAGECOMPSIZERGB are zero,
then CAP_BLANKPAGEMODE is automatically changed to TWBM_NONE.
CAP_BLANKPAGECONTENT Custom: i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: 0 - 100
Default: 0
- If the percent of content on the image is less than or equal to this amount, the image will be deleted.
- This is only valid when CAP_BLANKPAGEMODE is set to TWBM_CONTENT.
CAP_CAMERAENABLE Custom: All Models (except for 5000/7000/9000)
Allowed: FALSE, TRUE
Default 3590: Front Bitonal - FALSE, Rear Bitonal - always TRUE,
Front Color - TRUE
Default i55/i65/i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000: Front/Rear Color - FALSE, Front/Rear Bitonal - TRUE
Default Other: Front/Rear Color - TRUE, Front/Rear Bitonal - FALSE
- For use with Multistream(tm), this field must be set to TRUE to get the TWAIN driver to transfer
the image for that camera. Use DG_CONTROL / DAT_FILESYSTEM / MSG_CHANGEDIRECTORY
to select the camera to set. If using the 3590, CAP_BINARIZATION must be set for these fields
to have any meaning.
CAP_CAMERAORDER Custom: All Models (except for 5000/7000/9000)
Allowed: TWCM_CL_BOTH/TWCM_BW_BOTH or TWCM_BW_BOTH/TWCM_CL_BOTH
Default: TWCM_CL_BOTH/TWCM_BW_BOTH
- An array determining which should be transferred first for a side: the color or the bitonal image.
CAP_CAMERAPREVIEWUI Unsupported.
CAP_CAPTION Standard: All Models (except for i2000/i2900/i3000/i4000/i5000)
Allowed: Any TW_STR255 string
Default: (empty string)
CAP_CHECKDIGIT Custom: i800/i1800 Series
Allowed: FALSE, TRUE
Default: FALSE
- If set to TRUE the scanner will check image address digit.
CAP_CLEARBUFFERS Standard: All Models (except for i2000/i2900/i3000/i4000/i5000)
Allowed: 3000/4000/5000/7000/9000: TWCB_AUTO, TWCB_CLEAR, TWCB_NOCLEAR
Other: TWCB_AUTO (Read Only)
Default: TWCB_AUTO
CAP_CLEARPAGE Unsupported.
CAP_CUSTOMDSDATA Standard: All Models
Allowed: TRUE
Default: TRUE
- This is a read-only capability.
CAP_CUSTOMINTERFACEGUID Standard: i2000/i2900/i3000/i5000
Allowed: {642881CE-9F18-448c-8FD8-F77A51E0B85A}
Default: {642881CE-9F18-448c-8FD8-F77A51E0B85A}
- Uniquely identifies an interface for a Data Source, so that an Application can properly interpret its custom content.
- This is a read-only capability.
CAP_DEVICEEVENT Standard: All Models
Allowed: TWDE_PAPERJAM, TWDE_PAPERDOUBLEFEED
Default: (empty TW_ARRAY)
- TWDE_PAPERDOUBLEFEED is on all models (except for 5000/7000/9000).
CAP_DEVICEONLINE Standard: All Models
Allowed: FALSE, TRUE
Default: (none)
- This is a read-only capability.
- To comply with the TWAIN specification the Source issues a command to the device to confirm that it is up and communicating (the command used is a SCSI test-unit-ready command).
CAP_DEVICETIMEDATE Standard: All Models (except for 5000/7000/9000)
Allowed: TW_STR32 of the form YYYY/MM/DD HH:MM:SS.sss
Default: (none)
CAP_DOCUMENTCOUNT Custom: 5000/7000/9000 Series
Allowed: 0 - 999999999
Default: 0
- This value overrides CAP_PRINTERINDEX if CAP_DOCUMENTCOUNTENABLED == TRUE
CAP_DOCUMENTCOUNTENABLED Custom: 5000/7000/9000 Series
Allowed: FALSE, TRUE
Default: FALSE
- Determines if the CAP_DOCUMENTCOUNT is downloaded to the scanner.
CAP_DOUBLEFEEDENDJOB Custom: i600/i700/i800/i1800/i2000/i2900/i3000/i4000/i5000 Series
Allowed: FALSE, TRUE
Default: TRUE
- If set to TRUE the scanner will stop scanning on detection of a multifeed.
CAP_DOUBLEFEEDSTOP Custom: All Models (except for 5000/7000/9000)
Allowed: FALSE, TRUE
Default: TRUE
- If set to TRUE the scanner will stop scanning on detection of a multifeed. The 3000/4000 scanners will disable.
CAP_DUALSTACKINGENABLED Custom: i5000 Series
Allowed: FALSE, TRUE
Default: FALSE
- If
set to TRUE
the Controlled Dual Stacking Accessory will be enabled.
- It
can only be enabled if the accessory is installed.
CAP_DUALSTACKINGLENGTHMODE Custom: i5000 Series
Allowed: TWDSLM_NONE, TWDSLM_LESSTHAN, TWDSLM_GREATERTHAN,
TWDSLM_BETWEEN
Default: TWDSLM_NONE
- Indicates
the
length method being used to make document separation decisions
for the Controlled Dual Stacking Accessory. The stacking length mode only
has meaning if CAP_DUALSTACKINGENABLED is TRUE.
CAP_DUALSTACKINGLENGTH1 Custom: i5000 Series
Allowed: Scanner specific
Default: Scanner specific
- If
CAP_DUALSTACKINGLENGTHMODE is "less than", then any documents shorter
than this length will be separated and placed
in the selected CAP_DUALSTACKINGSTACK.
-
If CAP_DUALSTACKINGLENGTHMODE is "greater than", then any documents
longer
than this length will be separated and placed
in the selected CAP_DUALSTACKINGSTACK.
-
If CAP_DUALSTACKINGLENGTHMODE is "between", then any documents longer
than
this length and shorter than
CAP_DUALSTACKINGLENGTH2 will be separated and placed in the
selected CAP_DUALSTACKINGSTACK.
-
Only valid if CAP_DUALSTACKINGENABLED is TRUE and CAP_DUALSTACKINGLENGTHMODE
is set to any value other than TWDSLM_NONE.
-
The range is determined by the scanner, so an application might want to
ask what the range is
CAP_DUALSTACKINGLENGTH2 Custom: i5000 Series
Allowed: Scanner specific
Default: Scanner specific
- If CAP_DUALSTACKINGLENGTHMODE is "between", then
any documents whose length falls within
the selected range of CAP_DUALSTACKINGLENGTH1 and CAP_DUALSTACKINGLENGTH2 will be
separated and placed
in the selected CAP_DUALSTACKINGSTACK.
- Only valid if CAP_DUALSTACKINGENABLED is TRUE and
CAP_DUALSTACKINGLENGTHMODE
is
set to TWDSLM_BETWEEN.
- The
range is determined by the scanner, so an application might want to
ask what the range is.
CAP_DUALSTACKINGMULTIFEED Custom: i5000 Series
Allowed: FALSE, TRUE
Default: FALSE
- Indicates if Multifed documents
should be separated and placed in
the
selected CAP_DUALSTACKINGSTACK.
- Only valid if CAP_DUALSTACKINGENABLED is TRUE.
CAP_DUALSTACKINGPATCHTRANSFER
Custom: i5000
Series
Allowed: FALSE, TRUE
Default: FALSE
- Indicates if Patch Type Transfer documents should be
separated and placed in
the
selected CAP_DUALSTACKINGSTACK.
- Only valid if CAP_DUALSTACKINGENABLED is TRUE.
CAP_DUALSTACKINGPATCHTYPE1
Custom: i5000 Series
Allowed: FALSE, TRUE
Default: FALSE
- Indicates if Patch Type 1
documents should be separated and placed in
the
selected CAP_DUALSTACKINGSTACK.
- Only valid if CAP_DUALSTACKINGENABLED is TRUE.
CAP_DUALSTACKINGPATCHTYPE2
Custom: i5000 Series
Allowed: FALSE, TRUE
Default: FALSE
- Indicates if Patch Type 2 documents should be separated and
placed in
the
selected CAP_DUALSTACKINGSTACK.
- Only valid if CAP_DUALSTACKINGENABLED is TRUE.
CAP_DUALSTACKINGPATCHTYPE3
Custom: i5000 Series
Allowed: FALSE, TRUE
Default: FALSE
- Indicates if Patch Type 3 documents should be separated and
placed in
the
selected CAP_DUALSTACKINGSTACK.
- Only valid if CAP_DUALSTACKINGENABLED is TRUE.
CAP_DUALSTACKINGPATCHTYPE4
Custom: i5000 Series
Allowed: FALSE, TRUE
Default: FALSE
- Indicates if Patch Type 4 documents should be separated and
placed in
the
selected CAP_DUALSTACKINGSTACK.
- Only valid if CAP_DUALSTACKINGENABLED is TRUE.
CAP_DUALSTACKINGPATCHTYPE6
Custom: i5000 Series
Allowed: FALSE, TRUE
Default: FALSE
- Indicates if Patch Type 6 documents should be separated and
placed in
the
selected CAP_DUALSTACKINGSTACK.
- Only valid if CAP_DUALSTACKINGENABLED is TRUE.
CAP_DUALSTACKINGSTACK Custom: i5000 Series
Allowed: TWDSS_STACK1, TWDSS_STACK2
Default: TWDSS_STACK1
- Indicates
which stack to put detected documents in when a document matches the
defined stacking criteria (patch type,
length, and/or multifeed).
- Only valid if CAP_DUALSTACKINGENABLED is TRUE.
CAP_DUPLEX Standard: All Models
Allowed: TWDX_NONE, TWDX_1PASSDUPLEX
Default: TWDX_NONE for Simplex scanners, and TWDX_1PASSDUPLEX for Duplex scanners
- This is a read-only capability.
CAP_DUPLEXENABLED Standard: All Models
Allowed: FALSE, TRUE
Default: TRUE
- If CAP_DUPLEX is TWDX_NONE, then this capability is FALSE.
CAP_EASYSTACKING Custom: i600/i700/i1800
Allowed: FALSE, TRUE
Default: FALSE
- If set to TRUE then the scanner makes adjustments to improve the arrangement of the output stack as the paper exits the transport.
CAP_ENABLECOLORPATCHCODE Custom: 3590
Allowed: FALSE, TRUE
Default: FALSE
- Controls recognition of the patch code that moves the scanner mirror, letting it scan bitonal or color on the front camera.
CAP_ENABLEDSUIONLY Standard: All Models (except for i2000/i2900/i3000/i4000/i5000)
Allowed: TRUE
Default: TRUE
- This is a read-only capability.
CAP_ENDORSER Unsupported.
CAP_ENERGYSTAR Custom: All Models (except for i800/3000/4000/5000/7000/9000)
Allowed: i30/i40/i55/i65/i100/i600/i700/i1800: 0, 5 - 60
i200: 0, 15 - 60
i1100/i1200/i1300/i1400: 0, 5 - 240
i2000/i4000/i5000: 5 - 240
i900/i2900/i3000: 1 - 240
Default: 15
- Selects the idle time required before the Energy Star power saver is activated.
CAP_EXTENDEDCAPS Unsupported.
CAP_FEEDERALIGNMENT Standard: All Models (except for 3000/4000/5000/7000/9000)
Allowed: TWFA_CENTER
Default: TWFA_CENTER
- This is a read-only capability
CAP_FEEDERENABLED Standard: All Models
Allowed: FALSE, TRUE
Default: TRUE
- i200: FALSE is only permitted if the flatbed platen is installed.
- This is always TRUE for all other models and read only (except for i2000/i2900/i3000/i4000/i5000).
CAP_FEEDERKEEPALIVE Custom: 3000/4000 Series
Allowed: FALSE, TRUE
Default: FALSE
- If TRUE the feeder is kept running forever waiting for the first sheet of paper.
CAP_FEEDERLOADED Standard: All Models
Allowed: TRUE
Default: TRUE
- This is a read-only capability.
- See CAP_PAPERDETECTABLE.
CAP_FEEDERMODE Custom: i280/i1440/i2000/i2900/i3000/i4000/i5000
Allowed: i280/i1440: TWFM_NONE, TWFM_SPECIAL
Other: Scanner specific
Default: i280/i1440: TWFM_NONE
Other: Scanner specific
- CAP_FEEDERMODE is for Special Document
- For i1440, TWFM_NONE will show “Off” on the UI, TWFM _SPECIAL will show “On”.
CAP_FEEDERORDER Unsupported.
CAP_FEEDPAGE Unsupported.
CAP_FIXEDDOCUMENTSIZE Custom: 3000/4000 Series (except for 3500)
Allowed: FALSE, TRUE
Default: FALSE
- Set this value to true to speed up scanning. Note that the speed up can only occur if all of the documents in the batch are the same size. Speed-up is from 75ppm to 85ppm for 8.5x11 documents fed landscape.
CAP_FOLDEDCORNER Custom: i600/i700
Allowed: TWFC_DISABLED, TWFC_STOP, TWFC_ENDOFJOB
Default: TWFC_DISABLED
- Controls Folded Corner detection and the action taken if one is discovered during scanning.
- This is TWFC_DISABLED and read-only at this time.
CAP_FOLDEDCORNERSENSITIVITY Custom: i600/i700
Allowed: 1 - 100
Default: 2
- Controls the folded corner sensitivity, if folder corner detection is turned on.
- This is a read-only capability at this time.
CAP_FUNCTIONKEY1
CAP_FUNCTIONKEY2
CAP_FUNCTIONKEY3 Custom: i800/i1800 Series
Allowed: TWFK_NONE, TWFK_ENDOFJOB, TWFK_TERMINATEBATCH, TWFK_SKIPMULTIFEED, TWFK_SKIPPRINTING, TWFK_SKIPBATCH
Default: TWFK_NONE
- Controls the programmable keys on the scanner console.
CAP_IMAGEADDRESS Custom: 5000/7000/9000/i800/i1800 Series
Allowed: Any valid image address
Default: i800: None. Empty string indicates to use the current scanner value.
i1800: Current scanner value. Empty string indicates to use Scanner defaults (ex: .0.0.1)
Other: DEFAULT
- Specifies the image address used to start this session.
CAP_IMAGEADDRESSENABLED Custom: 5000/7000/9000 Series
Allowed: FALSE, TRUE
Default: FALSE
- Determines if the CAP_IMAGEADDRESS is downloaded to the scanner.
CAP_IMAGEADDRESSTEMPLATES Custom: i800/i1800 Series
Allowed: TWIA_CUSTOM, TWIA_NONE, TWIA_1 - TWIA_5
Default: TWIA_1
- Populates the template and level to follow fields.
TWIA_CUSTOM is a read only value and if CAP_IMAGEADDRESS_A or B, C, D or CAP_LEVELTOFOLLOW1, 2, 3 are changed, then this capability will revert to TWIA_CUSTOM.
TWIA_NONE is Fix "FFFFFFFFF"
TWIA_1 is Level 3 "FFFFFFFFF.333333.222222.111111"
TWIA_2 is Level 2 "FFFFFFFFF.222222222.111111111"
TWIA_3 is Level 1 "FFFFFFFFF.111111111"
TWIA_4 is Level 3 Offset "FFFFFFFFF.333333333.222222222"
TWIA_5 is Level 2 Offset "FFFFFFFFF.222222222"
CAP_IMAGEADDRESS_A
CAP_IMAGEADDRESS_B
CAP_IMAGEADDRESS_C
CAP_IMAGEADDRESS_D Custom: i800/i1800 Series
Allowed: F, 3, 2, 1 or nothing, according to the image address template rules (see the context sensitive help for this field for more information)
Default: FFFFFFFFF.333333.222222.111111
- Specifies the image address template.
CAP_IMAGESDIFFERENT Custom: i2000/i2900/i3000/i4000/i5000
Allowed: FALSE, TRUE
Default: FALSE
- When this is TRUE the user can set different values for the color and bitonal cameras.
- When set to FALSE a value set on a color camera will be matched (if possible) by the bitonal camera, and vice versa.
CAP_IMAGEMAGNIFICATIONFACTOR
Unsupported.
CAP_IMAGEMERGE Custom: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000
Allowed: TWIM_NONE, TWIM_FRONTONTOP, TWIM_FRONTONBOTTOM, TWIM_FRONTONLEFT, TWIM_FRONTONRIGHT
Default: TWIM_NONE
- Merges the front and back images into a single image that is returned to the application.
CAP_INDICATORS Standard: All Models
Allowed: FALSE, TRUE
Default: FALSE
- The TWAIN default is TRUE, so it is up to the Application to turn the indicator off if it wants complete UI-less control of the Source.
- The Source supports pTW_UIINTERFACE.ShowUI being FALSE, but CAP_INDICATORS being TRUE. In this case the Source will display just the Progress tab.
CAP_INDICATORSWARMUP Custom: All Models (except for 3000/4000/5000/7000/9000/i800)
Allowed: TRUE, FALSE
Default: TRUE
- Controls the appearance of the LampSaver and Warmup dialogs. Only turn this off if these dialogs are interfering with the operation of your application.
CAP_INTELLIGENTDOCUMENTPROTECTION
Custom: i2900/i3000 Series
Allowed: TWIDP_NONE, TWIDP_MINIMUM, TWIDP_NORMAL, TWIDP_MAXIMUM
Default: TWIDP_NORMAL
- Controls the level of document protection.
CAP_JOBCONTROL Unsupported.
CAP_LANGUAGE Standard: All Models
Allowed: TWLG_ENGLISH*
TWLG_CHINESE*
TWLG_CZECH
TWLG_DUTCH*
TWLG_FRENCH*
TWLG_GERMAN*
TWLG_ITALIAN*
TWLG_JAPANESE
TWLG_KOREAN*
TWLG_PORTUGUESE*
TWLG_RUSSIAN
TWLG_SPANISH*
TWLG_TURKISH
Default: The application's language[1]
CAP_LEVELTOFOLLOW1
CAP_LEVELTOFOLLOW2
CAP_LEVELTOFOLLOW3 Custom: i800/i1800 Series
Allowed: TWPL_LEVEL1, TWPL_LEVEL2, TWPL_LEVEL3
Default: TWPL_LEVEL1
- Specifies the level to follow rules for the current image address template.
CAP_MAXBATCHBUFFERS Unsupported.
CAP_MODE Custom: 5000/7000/9000 Series
Allowed: 1 - 18
Default: 1
- Allows the selection of the mode to be used during the scanning session.
- Only one mode is permitted per session.
CAP_MULTIFEEDCOUNT Custom: All Models (except for i800/3000/4000/5000/7000/9000)
Allowed: 0 - 32767
Default: 0
- Count of multifeeds per scan session.
- Setting this capability has no effect.
CAP_MULTIFEEDRESPONSE Custom: i600/i700/i900/i1100/i1200/i1300/i1400/i1800/i2000/i2900/i3000/i4000/i5000
Allowed: i1100: TWMR_CONTINUE, TWMR_ENDOFJOB
i600/i700/i1800: TWMR_CONTINUE, TWMR_ENDOFJOB, TWMR_STOPFEEDER
i1200/i1300/i1400: TWMR_CONTINUE, TWMR_ENDOFJOB, TWMR_ENDOFJOBLEAVEPAPER
i900/i2000: TWMR_CONTINUE, TWMR_ENDOFJOB, TWMR_ENDOFJOBLEAVEPAPER, TWMR_ENDOFJOBGENERATEIMAGE
i2900/i3000/i4000/i5000: TWMR_CONTINUE, TWMR_ENDOFJOB, TWMR_ENDOFJOBLEAVEPAPER, TWMR_ENDOFJOBGENERATEIMAGE,
TWMR_STOPFEEDER, TWMR_STOPFEEDERLEAVEPAPER
Default: TWMR_ENDOFJOB
- Action taken when the multifeed detected.
- Note: The allowed values may have been changed after the initial release of the scanner. So it is best to get the list from the TWAIN driver.
CAP_MULTIFEEDSOUND Custom: All Models (except for i800/3000/4000/5000/7000/9000)
Allowed: Text
Default: "ding.wav"
- Sound played when detect document multifeeds.
CAP_MULTIFEEDTHICKNESSDETECTION
Custom: 3000 Series (except for 3500)
Allowed: FALSE, TRUE
Default: FALSE
- Turns multifeed thickness detection on or off.
CAP_NOWAIT Custom: All Models
Allowed: FALSE, TRUE
Default: FALSE
- If set to TRUE then potentially blocking commands (ones that wait for image data from the scanner) will return TWRC_BUSY if they are not ready. This allows the application to poll the command until data does arrive, which prevents applications from appearing to hang from the user's point of view.
CAP_PAGECOUNT Custom: All Models (except for 5000/7000/9000)
Allowed: 0 - 32767
Default: 0 (disabled)
- If CAP_XFERCOUNT is set to -1 and this field is non-zero, then the specified number of sheets of paper will be scanned. This keeps the application from having to figure out how what value of CAP_XFERCOUNT is needed to get a specific number of sheets of paper scanned.
CAP_PAGESIZELIMIT Custom: All Models (except for 5000/7000/9000)
Allowed: 0 - ICAP_PHYSICALHEIGHT
Default: 0 (disabled)
- This is a double document detection system. If greater than zero then the scanner will detect an attempt to scan anything larger than the specified length value. The AddPageSizeLimit in the CONST.INI file can be modified to change the fudge factor in identifying multifeeds.
- The i30/i40/i55/i65 cannot guarantee multifeed detection for documents that are 14” in length if allows value is 14.77.
CAP_PAPERDETECTABLE Standard: All Models
Allowed: FALSE
Default: FALSE
- Indicates that the scanner cannot detect the presence of paper in the feeder area.
- This is a read-only capability.
CAP_PAPERSOURCE Custom: All Models (except for 4000/5000/7000/9000)
Allowed: i30/i40/i100/i900/i1100: TWPU_ADF.
Allowed: i55/i65: TWPU_ADF, TWPU_AUTO, TWPU_PLATEN
Allowed: i200/i1200/i1300/i1400/i2000: TWPU_ADF. If platen installed TWPU_AUTO and TWPU_PLATEN also allowed.
Allowed: i600/i700/i1800/i4000: TWPU_ADF, TWPU_ELEVATOR100, TWPU_ELEVATOR250, TWPU_ELEVATOR500
Allowed: i5000: TWPU_ADF,
TWPU_ELEVATOR100, TWPU_ELEVATOR250, TWPU_ELEVATOR500, TWPU_ELEVATOR750
Allowed: i2900/i3000: TWPU_ADF,
TWPU_ELEVATOR100, TWPU_ELEVATOR250. If platen installed TWPU_AUTO,
TWPU_PLATEN,
TWPU_ELEVATOR100PLATEN, TWPU_ELEVATOR250PLATEN also allowed
Default: i30/i40/i100/i200/i900/i1100: TWPU_ADF
Default: i600/i700/i1800/i4000: TWPU_ELEVATOR500
Default: i5000: TWPU_ELEVATOR750
Default: i55/i65i/1200/i1300/i1400/i2000: TWPU_AUTO
Default: i2900/i3000: TWPU_ELEVATOR250. If platen installed TWPU_ELEVATOR250PLATEN.
- TWPU_ADF- Selects source of paper (ADF or Platen). TWPU_AUTO. Selects ADF but changes to platen if the ADF has no paper in it at the start of the scanning session.
CAP_PATCHCOUNT Custom: i280/i600/i700/i1400/i1800/i4000/i5000
Allowed: 0 - 32767
Default: 0
- Count of patches per scan session.
- Setting this capability has no effect.
CAP_PATCHHEAD1 Custom: i1800
Allowed: TRUE/FALSE
Default: TRUE
- Enables/disables the first patch reader
CAP_PATCHHEAD2 Custom: i1800
Allowed: TRUE/FALSE
Default: TRUE
- Enables/disables the second patch reader
CAP_PATCHHEAD3 Custom: i1800
Allowed: TRUE/FALSE
Default: TRUE
- Enables/disables the third patch reader
CAP_PATCHHEAD4 Custom: i1800
Allowed: TRUE/FALSE
Default: TRUE
- Enables/disables the fourth patch reader
CAP_PCARDENABLED Unsupported.
CAP_POWEROFFTIMEOUT Custom: i2900/i3000 series
Allowed: i2900/i3000: 0 - 240
Default: 60
- Selects the number of minutes to wait after the scanner enters low power mode, before it powers off
CAP_POWERSUPPLY Unsupported.
CAP_PRINTER Standard: 3520/4500/5000/7000/i200/i600/i700/i800/i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: TWPR_IMPRINTERTOPBEFORE,
TWPR_IMPRINTERBOTTOMBEFORE (except i600/i700/i800/i1800/i4000/i5000),
TWPR_IMPRINTERBOTTOMAFTER ( i200/i1400 only).
Default 3520/4500: TWPR_IMPRINTERTOPBEFORE
Default 5000/7000: TWPR_IMPRINTERTOPBEFORE (TWPR_IMPRINTERBOTTOMBEFORE if there is no top printer)
Default i200/i1400/i2900/i3000: TWPR_IMPRINTERBOTTOMAFTER
Default i600/i700/i800/i1800/i4000/i5000: TWPR_IMPRINTERTOPBEFORE
CAP_PRINTERDATE Custom: i600/i700/i1800/i2900/i3000/i4000/i5000
Allowed: YYYY/MM/DD (YYYY - year, MM - month, DD - day)
Default: empty string
- Set to empty string to disable.
- This will set the scanner to a specific date prior to printing.
- The scanner will be returned to the original date afterwards.
CAP_PRINTERDATEDELIMITER Custom: 3520/4500/5000/7000/i200/i600/i700/i800/i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: TWPD_NONE, TWPD_FORWARDSLASH, TWPD_HYPHEN, TWPD_PERIOD, TWPD_BLANK
Default i800: TWPD_FORWARDSLASH
Default Other: TWPD_NONE
- Selects the delimiter between the fields in the date. The delimiter in the time field is always a colon (:).
CAP_PRINTERDATEFORMAT Custom: i600/i700/i800/i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: i600/i800/i1400: TWPE_MMDDYYYY, TWPE_DDMMYYYY, TWPE_YYYYMMDD,
Other: TWPE_MMDDYYYY, TWPE_DDMMYYYY, TWPE_YYYYMMDD, TWPE_DDD, TWPE_YYYYDDD
Default: i800: TWPE_MMDDYYYY
Default: Other: TWPE_YYYYMMDD
- Selects the format of the date.
 Note that printing for the 5000/7000 is side dependent.
CAP_PRINTERFONT Custom: 3520/4500/5000/7000/i200/i600/i700/i800/i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: 3520/4500/5000/7000/i200/i1400: TWPN_LARGECOMIC, TWPN_LARGECINE, TWPN_SMALLCOMIC, TWPN_SMALLCINE
i600/i700/i800/i1800: TWPN_LARGECOMIC, TWPN_LARGECINE, TWPN_LARGECOMIC180, TWPN_LARGECINE180,
TWPN_SMALLCOMIC, TWPN_SMALLCINE, TWPN_SMALLCOMIC180, TWPN_SMALLCINE180
i2900/i3000/i5000: TWPN_LARGECOMIC, TWPN_LARGECINE, TWPN_LARGECOMIC180, TWPN_LARGECINE180,
TWPN_SMALLCOMIC, TWPN_SMALLCINE, TWPN_SMALLCOMIC180, TWPN_SMALLCINE180,
TWPN_BOLDLARGECOMIC, TWPN_BOLDLARGECINE, TWPN_BOLDLARGECOMIC180, TWPN_BOLDLARGECINE180
i4000: TWPN_LARGECOMIC, TWPN_LARGECINE, TWPN_LARGECOMIC180, TWPN_LARGECINE180,
TWPN_SMALLCOMIC, TWPN_SMALLCINE, TWPN_SMALLCOMIC180, TWPN_SMALLCINE180,
TWPN_BOLDLARGECOMIC, TWPN_BOLDLARGECINE
Default: i800/i2900/i3000/i4000/i5000: TWPN_SMALLCOMIC
Other: TWPN_LARGECOMIC
- This selects the printing font.
CAP_PRINTERFONTFORMAT Custom: i1800
Allowed: TWPFF_NORMAL, TWPFF_BLOCK
Default: TWPFF_NORMAL
- Elects the printer font format to be used
CAP_PRINTERIMAGEADDRESSFORMAT
Custom: 5000/7000/i800/i1800 Series
Allowed: TWPI_DISPLAYLEADINGZEROS, TWPI_SUPPRESSLEADINGZEROS, TWPI_COMPRESSLEADINGZEROS
Default 5000/7000: TWPI_DISPLAYLEADINGZEROS
Default i800/i1800: TWPI_SUPPRESSLEADINGZEROS
- This selects the format of the image address, if it is selected for printing.
CAP_PRINTERIMAGEADDRESSLEVEL
Custom: 5000/7000/i800/i1800 Series
Allowed 5000/7000: TWPL_ALLLEVELS, TWPL_LEVEL0, TWPL_LEVEL1, TWPL_LEVEL2, TWPL_LEVEL3
Allowed i800/i1800: TWPL_ALLLEVELS, TWPL_LEVEL1, TWPL_LEVEL2, TWPL_LEVEL3
Default: TWPL_ALLLEVELS
- This selects which level document the described printing will occur upon.
CAP_PRINTERINDEX Standard: 3520/4500/5000/7000/i200/i600/i700/i800/i1400/i1800/i2000/i2900/i3000/i4000/i5000 Series
Allowed: 0 - 999999998
Default i600/i700/i1800: 1
Default Other : 0
- This value is shared with CAP_DOCUMENTCOUNT, it CAP_DOCUMENTCOUNTENABLED == TRUE, then that
value will override this one.
CAP_PRINTERINDEXDIGITS Custom: 3520/4500/5000/7000/i200/i600/i700/i800/i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: 1 - 9
Default: 9
- Sets the number of digits of the counter to be printed. Note that the data will be truncated if the number of digits in the count exceeds this value.
CAP_PRINTERINDEXFORMAT
Custom: 3520/4500/5000/7000/i200/i600/i700/i800/i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: TWPI_DISPLAYLEADINGZEROS, TWPI_SUPPRESSLEADINGZEROS, TWPI_COMPRESSLEADINGZEROS
Default i800: TWPI_SUPPRESSLEADINGZEROS
Default Other: TWPI_DISPLAYLEADINGZEROS
- This selects the format of the document count, if it is selected for printing.
CAP_PRINTERMODE Standard: 5000/7000/i2900/i3000/i4000/i5000 Series
Allowed: TWPM_SINGLESTRING, TWPM_COMPOUNDSTRING
Default: TWPM_SINGLESTRING
- TWPM_SINGLESTRING allows the full range of printer features to be expressed.
- TWPM_COMPOUNDSTRING follows the guidelines of the TWAIN 1.8 specification.
CAP_PRINTERPOSITION Custom: 3520/4500/5000/7000/i200/i600/i700/i800//i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: Scanner specific
Default: Scanner specific
- This selects the position from the top of the page where printing is to begin.
CAP_PRINTERSTRING Standard: i2900/i3000/i4000/i5000 Series
Allowed: Any string (up to 40 characters)
Default: “111”
- This capability is the same as CAP_PRINTERWRITESEQUENCEMESSAGE1.
CAP_PRINTERSUFFIX Standard: 5000/7000/i200/i600/i700/i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: 5000/7000: Any string
i600/i700/i1800/i5000: Any string (up to 20 characters)
i200/i1400/i2900/i3000/i4000: Any string (up to 40 characters)
Default: 5000/7000: (empty string)
i200/i600/i700/i1400: “ABC”
i1800/i2900/i3000/i4000/i5000: “111”
CAP_PRINTERTIME Custom: i600/i700/i1800/i2900/i3000/i4000/i5000
Allowed: HH:MM (HH - hour (0-23), MM - minutes (0-59), i.e. 00:00->23:59)
Default: empty string
- Set to empty string to disable.
- This will set the scanner to a specific time prior to printing.
- The scanner will be returned to the original time afterwards.
CAP_PRINTERWRITESEQUENCE Custom: 5000/7000/i200/i600/i700/i800/i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: refer to kdscust.h
Default: TWPW_NONE
- Determines what will be printed.
- Use CAP_PRINTERWRITESEQUENCEINDEX to move through each of the items.
- Use CAP_PRINTERIMAGEADDRESSLEVEL to specify the level being targeted for printing.
CAP_PRINTERWRITESEQUENCEINDEX
Custom: 5000/7000 Series
Allowed: 1 - 7
Default: 1
- Selects the current CAP_PRINTERWRITESEQUENCE item being set.
CAP_PRINTERWRITESEQUENCEMESSAGE
Custom: 3520/4500/5000/7000/i200/i600/i700/i800/i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: TWTY_STR32
Default: #n, where n is the message number
- 5000/7000: There are nine of these, CAP_PRINTERWRITESEQUENCEMESSAGE1 through 9.
- 3520/4500: There is one of these, CAP_PRINTERWRITESEQUENCEMESSAGE.
- i600/i700/i800/i1800/i5000: There are 6 of these, CAP_PRINTERWRITESEQUENCEMESSAGE1 through 6.
- i200/i1400/i2900/i3000/i4000: There is only one of message, CAP_PRINTERWRITESEQUENCEMESSAGE1.
- The CAP_PRINTERWRITESEQUENCE selects the message number and its position in the write sequence.
CAP_PRINTERWRITESEQUENCEMESSAGEINDEX
Custom: i200/i600/i700/i1400/i1800
Allowed: i200/i1400: 1
i600/i700/i1800: 1 - 6
Default: 1
- Selects the write sequence message.
- This is a read-only capability.
CAP_PRINTERWRITESEQUENCESPACE
Custom: 5000/7000 Series
Allowed: 1 - 38
Default: 1
- Selects the number of blanks to print at the location selected by CAP_PRINTERWRITESEQUENCE.
CAP_PRINTERWRITESEQUENCESPACESTRING
Custom: 5000/7000 Series
Allowed: TWTY_STR255
- Selects the write sequence count of spaces.
CAP_PRINTERWRITESEQUENCESTRING
Custom: 5000/7000/i200/i600/i700/i800/i1400/i1800/i2900/i3000/i4000/i5000 Series
Allowed: TWTY_STR255
- Selects the write sequence.
CAP_PROFILES Custom: i600/i700/i900/i1100/i1200/i1300/i1400/i1800/i2000/i2900/i3000/i4000/i5000
Allowed: TWPO_UNKNOWN, TWPO_DEFAULT, TWPO_FILE01 - 60
Default: (determined from the scanner)
- THIS IS DEPRECATED TWAIN 10.X+. DAT_PROFILES SHOULD BE USED INSTEAD.
- Allows the application to select the profile. Applications should only try to set the TWPO_FILE values. See the DAT_PROFILES operation for a way to map the display strings to the various CAP_PROFILES values.
CAP_REACQUIREALLOWED Unsupported.
CAP_REWINDPAGE Unsupported.
CAP_SERIALNUMBER Stanard: All Models (except for 5000/7000/9000)
Allowed: Up to 8 characters
Default: (none)
- This is a read-only capability.
CAP_SIDESDIFFERENT Custom: i600/i700/i900/i1100/i1200/i1300/i1400/i1800/i2000/i2900/i3000/i4000/i5000
Allowed: FALSE, TRUE
Default: FALSE
- When this is TRUE the user can set different values for the front and rear camera. Setting this to FALSE will copy all the front settings to the rear for the current camera.
- This will automatically change to TRUE when the front and rear no longer match. Note: a value of TRUE does NOT imply that the sides are different (e.g. if everything matches and this is set to TRUE)
CAP_SIMULATING Custom: i2000/i2900/i3000/i4000/i5000
Allowed: FALSE, TRUE
Default: FALSE
- Simulate the scanner.
CAP_SUPPORTEDCAPS Standard: All Models
Allowed: All supported capabilities named in this document
Default: (same as allowed)
- This is a read-only capability.
CAP_SUPPORTEDSIZES Standard: All Models
Allowed: i30/i40/i55/i65/i900/i1100/i1200/i1300/i1400: ISO A4 - A7, B5 - B7, C5 - C7; JIS B5 - B8;
Legal, Letter, Executive and Statement; TWSS_NONE
i100/i200/i600/i700/i800/i1800/i2000/i2900/i3000/i4000/i5000:
ISO A3 - A7, B4 - B7, C4 - C7; JIS B4 - B8;
US Ledger, Legal, Letter, Executive and Statement;
TWSS_NONE
Other: ISO A3 - A10, B4 - B10, C4 - C10; JIS B4 - B10; US Ledger, Legal,
Letter, Executive and Statement; TWSS_NONE
Default: Letter for U.S., ISO A4 for Metric
- If ICAP_FRAMES or DAT_IMAGELAYOUT are set, then this capability will revert to TWSS_NONE.
CAP_THUMBNAILSENABLED Unsupported.
CAP_TIMEBEFOREFIRSTCAPTURE Unsupported.
CAP_TIMEBETWEENCAPTURES Unsupported.
CAP_TIMEDATE Standard: All Models
Allowed: TW_STR32 of the form YYYY/MM/DD HH:MM:SS.sss
Default: (none)
- For reasons of efficiency the Source does not use the scanner clock to supply this time for the 3000/4000 Series, but instead uses the Host computer's clock. This may be changed in future.
CAP_TOGGLEPATCH Custom: i280/i600/i700/i800/i1400/i1800/i3000/i4000/i5000
Allowed: TWTP_DISABLED, TWTP_BOTHSIDE, TWTP_FRONTSIDE (except i600/i700), TWTP_SAMESIDE, TWTP_DETECTONLY
Default: TWTP_DISABLED
- Controls recognition of the color patch.
- For i1800 when in IA mode TWTP_SAMESIDE is unsupported, otherwise TWTP_FRONTSIDE is unsupported
CAP_TRANSPORTAUTOSTART Custom: All Models (except for i30/i40/i55/i65/3000/4000/5000/7000/9000)
Allowed: i900/i1100/i1200/i1300/i1400/i2000 TRUE (readonly)
Other FALSE, TRUE
Default: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000 TRUE
Other FALSE
- If set to TRUE the scanner will automatically begin scanning. If FALSE the user must press the start button on the scanner console to begin scanning.
CAP_TRANSPORTTIMEOUT Custom: All Models (except for 5000/7000/9000)
Allowed i30/i40/i55/i65: 1 - 30 seconds
Allowed 3000/4000/i100/i200: 3 - 30 seconds
Allowed i600/i700/i1100/i1200/i1300/i1400/i1800: 0 (disabled), 1 - 300 seconds
Allowed i800: 0 (disabled), 5 - 300 seconds
Allowed i900/i2000/i2900/i3000/i4000/i5000: 0
(disabled), 1 - 120 seconds
Default i30/i40/i55/i65/i1100/i1200/i1300: 1
Default i2900/i3000/i4000/i5000: 5
Default 3000/4000/i100/i200/i1400: 8
Default i600/i700/i1800: 15
Default i800: 10
Default i900/i2000: 0
- This controls the number of seconds the scanner transport will attempt to feed paper before it times out and stops. The 8xx modules will then apply the timeout response. The 3xxx/4xxx unconditionally end the session (see CAP_FEEDERKEEPALIVE).
CAP_TRANSPORTTIMEOUTRESPONSE
Custom: All Models (except for i30/i40/i55/i65/3000/4000/5000/7000/9000)
Allowed i600/i700/i800/i1800/i2900/i3000/i4000/i5000: TWTR_STOPFEEDER, TWTR_ENDOFJOB
Allowed i900/i1100/i1200/i1300/i1400/i2000: TWTR_ENDOFJOB
Default i600/i700/i800/i1800: TWTR_STOPFEEDER
Default i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000: TWTR_ENDOFJOB
- Determines the action taken when the scanner transport times out.
CAP_UICONTROLLABLE Standard: All Models (Except for i2000/i4000/i5000)
Allowed: TRUE
Default: TRUE
- This is a read-only capability.
CAP_ULTRASONICSENSITIVITY Custom: i100/i200/i600/i700/i800/i1200/i1300/i1400/i1800/i2000/i2900/i3000/i4000/i5000 Series
Allowed: TWUSS_DISABLED, TWUSS_LOW, TWUSS_MEDIUM, TWUSS_HIGH
Default: TWUSS_DISABLED
- Controls the use and sensitivity of the ultrasonic multifeed detection system.
CAP_ULTRASONICSENSORCENTER Custom: i600/i700/i1800/i4000/i5000 Series
Allowed i600/i700/i1800/i4000: TWUO_DISABLED, TWUO_ENABLED
Allowed i5000: TWUO_DISABLED, TWUO_ENABLED, TWUO_IGNOREZONE
Default: TWUO_ENABLED
- Controls the center ultrasonic multifeed detection sensor.
- If the current value is set to TWUO_IGNOREZONE then the height of the area to be ignored is controlled by
CAP_ULTRASONICSENSORZONEHEIGHT.
CAP_ULTRASONICSENSORLEFT Custom: i600/i700/i1800/i4000/i5000 Series
Allowed i600/i700/i1800/i4000: TWUO_DISABLED, TWUO_ENABLED
Allowed i5000: TWUO_DISABLED, TWUO_ENABLED, TWUO_IGNOREZONE
Default i600/i700/i1800/i4000: TWUO_ENABLED
Default i5000: TWUO_DISABLED
- Controls the left ultrasonic multifeed detection sensor.
- If the current value is set to TWUO_IGNOREZONE then the height of the area to be ignored is controlled by
CAP_ULTRASONICSENSORZONEHEIGHT.
CAP_ULTRASONICSENSORLEFTCENTER
Custom: i5000 Series
Allowed TWUO_DISABLED, TWUO_ENABLED, TWUO_IGNOREZONE
Default: TWUO_ENABLED
- Controls the left center ultrasonic multifeed detection sensor.
- If the current value is set to TWUO_IGNOREZONE then the height of the area to be ignored is controlled by
CAP_ULTRASONICSENSORZONEHEIGHT.
CAP_ULTRASONICSENSORRIGHT Custom: i600/i700/i1800/i4000/i5000 Series
Allowed i600/i700/i1800/i4000: TWUO_DISABLED, TWUO_ENABLED
Allowed i5000: TWUO_DISABLED, TWUO_ENABLED, TWUO_IGNOREZONE
Default i600/i700/i1800/i4000: TWUO_ENABLED
Default i5000: TWUO_DISABLED
- Controls the right ultrasonic multifeed detection sensor.
- If the current value is set to TWUO_IGNOREZONE then the height of the area to be ignored is controlled by
CAP_ULTRASONICSENSORZONEHEIGHT.
CAP_ULTRASONICSENSORRIGHTCENTER
Custom: i5000 Series
Allowed: TWUO_DISABLED, TWUO_ENABLED, TWUO_IGNOREZONE
Default: TWUO_ENABLED
- Controls the right center ultrasonic multifeed detection sensor.
- If the current value is set to TWUO_IGNOREZONE then the height of the area to be ignored is controlled by
CAP_ULTRASONICSENSORZONEHEIGHT.
CAP_ULTRASONICSENSORZONEHEIGHT
Custom: i5000 Series
Allowed: Scanner specific
Default: Scanner specific
- Height of zone for CAP_ULTRASONICSENSOR*s that are set to TWUO_IGNOREZONE. There is one height that applies to all sensors set to
TWUO_IGNOREZONE.
CAP_WINDOW Custom: i600/i700/i900/i1100/i1200/i1300/i1400/i1800/i2000/i2900/i3000/i4000/i5000
Allowed: TWWW_BASE
Default: TWWW_BASE
- (TBD).
CAP_WINDOWCAMERA Custom: i600/i700/i900/i1100/i1200/i1300/i1400/i1800/i2000/i2900/i3000/i4000/i5000
Allowed: TWWC_BASE_BITONAL_FRONT, TWWC_BASE_BITONAL_REAR, TWWC_BASE_COLOR_FRONT and TWWC_BASE_COLOR_REAR
Default: TWWC_BASE_BITONAL_FRONT
- (TBD).
CAP_WINDOWPOSITION Custom: All Models (except for i2000/i2900/i3000/i4000/i5000)
Allowed: A TW_FRAME value with valid settings for Top and Left
Default: 0 0
- This controls the location of the Source's GUI on the user's screen. Only the location can be selected, the Right and Bottom values are ignored.
CAP_XFERCOUNT Standard: All Models
Allowed: 5000/7000/9000: -1
Allowed: Other: -1, 1 to 37267
Default: -1
- This capability indicates the number of images to scan, not the number of sheets of paper, so in duplex mode a single sheet of paper generates two images.
- When set to -1 the scanner runs in batch mode.
- When set to 0 it will reset to 1 since zero is invalid xfercount.
- All models (except for 5000/7000/9000): For values greater than 0, the scanner uses page on demand mode so that it can get exactly the number of images requested. Please note that in this mode the scanner may scans each page separately, which could reduce its potential throughput.
- See CAP_AUTOSCAN.
5. ICAP_ Capabilites
ICAP_ADDBORDER Custom: All Models (except for i30/i40/i55/i65/3000/4000/5000/7000/9000)
Allowed: FALSE, TRUE
Default: FALSE
- If set to TRUE a 16-pixel border will be added on all sides of the image.
ICAP_AUTOBRIGHT Unsupported.
ICAP_AUTOCOLORAMOUNT Custom: All Models (except for i30/i40/i55/i65/i200/i800/i900/i1100/3000/4000/5000/7000/9000)
Allowed: 1 to 200
Default: 1
- This capability only available for ICAP_AUTOCOLORCONTENT set to Custom.
ICAP_AUTOCOLORCONTENT Custom: All Models (except for i30/i40/i55/i65/i200/i800/i900/i1100/3000/4000/5000/7000/9000)
Allowed: None, Low, Medium, High and Custom
Default: None
- The documents require amount of color to be saved as color.
ICAP_AUTOCOLORTHRERSHOLD Custom: All Models (except for i30/i40/i55/i65/i200/i800/i900/i1100/3000/4000/5000/7000/9000)
Allowed: 0 to 100
Default: i2000/i4000/i5000: 50
Other: 20
- This capability only available for ICAP_AUTOCOLORCONTENT set to Custom.
ICAP_AUTOMATICBORDERDETECTION
Standard: All Models
Allowed: FALSE, TRUE
Default: TRUE
- Setting is machine dependent with the 3520 (not side selectable)
ICAP_AUTOMATICCOLORENABLED Standard: i2000/i5000
Allowed: TRUE, FALSE
Default: FALSE
- Automatically detects the pixel type of the image and returns either a color image or a non-color image.
ICAP_AUTOMATICCOLORNONCOLORPIXELTYPE
Standard: i2000/i5000
Allowed: TWPT_BW
Default: TWPT_BW
- Specifies the non-color pixel type to use when automatic color is enabled.
ICAP_AUTOMATICDESKEW Standard: All Models
Allowed: FALSE, TRUE
Default: TRUE
- Setting is machine dependent with the 3520 (not side selectable)
ICAP_AUTOMATICLENGTHDETECTION
Standard: i2000/i5000
Allowed: TRUE
Default: TRUE
- Controls the automatic detection of the length of a document.
ICAP_AUTOMATICROTATE Standard: i700/i1200/i1300/i1400/i1800/i2000/i2900/i3000/i4000/i5000
Allowed: FALSE, TRUE
Default: FALSE
- If Automatic orthogonal rotation is supported (see Orthogonal Rotation), as well Auto-crop and Deskew (see Cropping),
then the TWAIN feature Automatic Rotate is also supported (ICAP_AUTOMATICROTATE).
ICAP_BACKGROUNDADJUSTAGGRESSIVENESS
Custom: i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: -10 to 10
Default: 0
- The background color adjustment aggressiveness.
- Only available for color camera.
ICAP_BACKGROUNDADJUSTAPPLYTO
Custom: i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: TWBA_ALL,TWBA_NEUTRAL,TWBA_PREDOMINATE
Default: TWBA_PREDOMINATE
- The background color adjustment apply to.
- Only available for color camera.
ICAP_BACKGROUNDADJUSTMODE
Custom: i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: i1200/i1300/i1400: TWBS_NONE,TWBS_AUTOMATIC,TWBS_CHANGETOWHITE
Other: TWBS_NONE,TWBS_AUTOMATICBASIC,TWBS_AUTOMATIC
Default: TWCL_NONE
- The background smoothing mode.
- Only available for color camera.
ICAP_BARCODEDETECTIONENABLED
Unsupported.
ICAP_BARCODEMAXRETRIES Unsupported.
ICAP_BARCODEMAXSEARCHPRIORITIES
Unsupported.
ICAP_BARCODESEARCHMODE Unsupported.
ICAP_BARCODESEARCHPRIORITIES Unsupported.
ICAP_BARCODETIMEOUT Unsupported.
ICAP_BITDEPTH Standard: All Models
Allowed: All allow 1, all allow 24 and 8 (except 3500/3510/3520/i610/i810/i830)
Default: 24 if color is supported, otherwise 1 (3590 is 1, i610 is 8)
- 1 only for /Camera_Bitonal_Both, /Camera_Bitonal_Top, /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW).
- 8 only for /Camera_Color_Both, /Camera_Color_Top, /Camera_Color_Bottom (ICAP_PIXELTYPE == TWPT_GRAY).
- 24 only for /Camera_Color_Both, /Camera_Color_Top, /Camera_Color_Bottom (ICAP_PIXELTYPE == TWPT_RGB).
- Please refer to the ICAP_PIXELTYPE section of faq.htm for more information.
ICAP_BITDEPTHREDUCTION Standard: All Models
Allowed: TWBR_THRESHOLD and TWBR_HALFTONES. TWBR_DIFFUSION (i600 only)
Default: TWBR_HALFTONES
- Capability is only available for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW).
ICAP_BITORDER Standard: All Models
Allowed: TWBO_MSBFIRST
Default: (same as allowed)
ICAP_BITORDERCODES Standard: All Models
Allowed: TWBO_MSBFIRST
Default: (same as allowed)
ICAP_BRIGHTNESS Standard: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: -1000 to -1000 step 20
Default: 0
- This capability is only available for /Camera_Color_Both, /Camera_Color_Top and /Camera_Color_Bottom.
- This is ignored if ICAP_COLORBRIGHTNESSMODE is set to TWCBR_AUTOMATIC
ICAP_CCITTKFACTOR Standard: 3000/4000/5000/7000/9000
Allowed: 0 to 255
Default: 4
- Capability is only available if ICAP_COMPRESSION is set to TWCP_GROUP32D.
ICAP_COLORBALANCEAUTOMATICAGGRESSIVENESS Custom: i900/i2000/i2900/i3000
Allowed: -2 to 2 step 1
Default: 0
- Indicates how aggressive the automatic white balance will be.
- This is only available when ICAP_COLORBALANCEMODE set to TWCBM_AUTOMATICADVANCED.
ICAP_COLORBALANCEBLUE Custom: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: -1000 to 1000 step 20
Default: 0
- Allow the user to adjust the color balance blue.
- Only available for color camera.
ICAP_COLORBALANCEGREEN Custom: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: -1000 to 1000 step 20
Default: 0
- Allow the user to adjust the color balance green.
- Only available for color camera.
ICAP_COLORBALANCEMODE Custom: i900/i2000/i2900/i3000/i5000
Allowed: i5000: TWCBM_NONE, TWCBM_MANUAL
Others: TWCBM_NONE, TWCBM_MANUAL, TWCBM_AUTOMATICBASIC, TWCBM_AUTOMATIC
Default: i5000: TWCBM_NONE
Others: TWCBM_AUTOMATICBASIC
- Allows the user to select the method for adjusting the color balance of a color image
- Only available for color camera.
ICAP_COLORBALANCERED Custom: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: -1000 to 1000 step 20
Default: 0
- Allow the user to adjust the color balance red.
- Only available for color camera.
ICAP_COLORBRIGHTNESSMODE Custom: i900/i2000/i2900/i3000/i5000
Allowed: i5000: TWCBR_NONE, TWCBR_MANUAL
Others: TWCBR_NONE, TWCBR_MANUAL, TWCBR_AUTOMATICBASIC
Default: i5000: TWCBR_NONE
Others: TWCBR_AUTOMATICBASIC
- Allows the user to select the method for adjusting the brightness and contrast of a color or grayscale image
- Only available for color camera.
ICAP_COLORSHARPEN Custom: i900/i2000/i2900/i3000/i4000/i5000
Allowed: 0 - 3
Default: 1
- Apply sharpening to image - 0 indicates no sharpening. 1 is normal, 2 is more sharpening, and a value of 3 applies a lot of sharpening.
- Only available for color camera.
ICAP_COLORSHARPENING Custom: 3590/4500/i820/i840/i1800
Allowed: TWCS_NONE, TWCS_3X3FIRFILTER
Default: TWCS_3X3FIRFILTER
- Capability is only available for ICAP_PIXELTYPE == TWPT_RGB or TWPT_GRAY.
- Capability is only available if ICAP_COMPRESSION is TWCP_JPEG.
ICAP_COLORTABLE Custom: All Models (except for 5000/7000/9000/i2000/i2900/i3000/i4000/i5000)
Allowed: TWCT_UNKNOWN, TWCT_DEFAULT, TWCT_FILE01 - 60
Default: (determined from the scanner)
- Allows the application to select the color table. Applications should only try to set the TWCT_FILE values. See the DAT_COLORTABLE operation for a way to map the display strings to the various ICAP_COLORTABLE values.
ICAP_COMPRESSION Standard: All Models
Allowed: 3000/4000/5000/7000/9000: TWCP_NONE, TWCP_GROUP31D, TWCP_GROUP32D, TWCP_GROUP4, TWCP_JPEG
Other: TWCP_NONE, TWCP_GROUP4, TWCP_JPEG
Default: TWCP_NONE
- TWCP_NONE, TWCP_GROUP31D, TWCP_GROUP32D, TWCP_GROUP4 only for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW).
- TWCP_NONE, TWCP_JPEG only for /Camera_Color_Top (ICAP_PIXELTYPE == TWPT_RGB or TWPT_GRAY).
- Please refer to the ICAP_COMPRESSION section of faq.htm for more information.
These applications are known to not support compression while scanning images (though they may support it in other areas)...
[NoCompression]
N0=Adobe Adam Adobe Acrobat Scan v1.0
N1=Adobe Systems Inc. Application Division Photoshop v1.0
N2=Adobe Systems Inc. Application Division Photoshop v1.31
N3=Eastman Software, Inc. Imaging for Windows Imaging v3.6
N4=Media Cybernetics, L.P. Scanning Utilities Microsoft Imager v2.0
N5=Wang Laboratories, Inc. OPEN/image v3.6
N6=Wang Laboratories, Inc. OPEN/image Imaging v3.6
N7=Xerox PerfectScan API Scanner Diagnostic v1.0
N8=Adobe Adobe v1.0
These applications are known to support compression while scanning images. Therefore the GUI will remember the last user settings for them
[YesCompression]
N0=Kodak Digital Science Scanner Validation Tool v.*
N1=Kodak Digital Science TWAIN Test Tool v.*
ICAP_CONTRAST Standard: All Models
Allowed: 5000/7000/9000: -980 to 1000 in steps of 10
Other: -1000 to -1000 step 20
Default: 5000/7000/9000: 240
Other: 0
- For i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000, the capability is available for all cameras
- For other scanner, the capability is only available for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW)
- This is ignored if ICAP_COLORBRIGHTNESSMODE is set to TWCBR_AUTOMATIC.
ICAP_CROPPINGMODE Custom: All Models (except for 3000/4000/5000/7000/9000)
Allowed i200: TWCR_AUTOMATICBORDERDETECTION, TWCR_AGGRESSIVE, TWCR_TRANSPORT, TWCR_DOCUMENT,TWCR_CONTINUOUS
i1400/i3000: TWCR_AUTOMATICBORDERDETECTION, TWCR_AGGRESSIVE, TWCR_TRANSPORT, TWCR_DOCUMENT,TWCR_CONTINUOUS, TWCR_PHOTO, TWCR_PHOTOINROI
i4000/i5000: TWCR_AUTOMATICBORDERDETECTION, TWCR_AGGRESSIVE, TWCR_TRANSPORT, TWCR_DOCUMENT, TWCR_PHOTO, TWCR_PHOTOINROI
Other: TWCR_AUTOMATICBORDERDETECTION, TWCR_AGGRESSIVE, TWCR_TRANSPORT, TWCR_DOCUMENT
Default i200: TWCR_TRANSPORT. (i280- TWCR_AUTOMATICBORDERDETECTION)
Other: TWCR_AUTOMATICBORDERDETECTION
- Specifies the mechanism used to crop the image data.
ICAP_CUSTHALFTONE Unsupported.
ICAP_DOCUMENTTYPE Custom: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: TWDT_PHOTO, TWDT_TEXTWITHGRAPHICS, TWDT_TEXTWITHPHOTO, TWDT_TEXT
Default: TWDT_TEXTWITHGRAPHIC
- Allows user to select the type of document being scanned.
ICAP_ECDO Custom: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: TWCD_UNKNOWN, TWCD_NONE, TWCD_FILE01 - 60
Default: None
- Allows user to select the ECDO color for bitonal/gray camera.
ICAP_ECDOAGGRESSIVENESS Custom: i2000/i2900/i3000/i4000/i5000
Allowed: -10 to 10
Default: 0
- Change the amount of multi-color dropout applied to a bitonal image..
ICAP_ECDOTREATASCOLOR Custom: i1400
Allowed: FALSE, TRUE
Default: FALSE
- Allows you to indicate that a color other than black or dark blue ink was used for the data entered on the form.
This is not available when ECDO is set to (none). This feature is not available for all models.
ICAP_EXPOSURETIME Unsupported.
ICAP_EXTIMAGEINFO Standard: All Models
Allowed: FALSE, TRUE
Default: TRUE
ICAP_FILTER Unsupported.
ICAP_FILTERBACKGROUND Custom: All Models (except for 900/3000/5000/7000/9000/i2000/i2900/i3000/i4000/i5000)
Allowed: 0 - 255
Default: 245
- Capability is only available for TWPT_BW or (on some systems) TWPT_GRAY.
- Selects the grayscale value used to replace the filtered color.
ICAP_FILTERENUM Custom: All Models (except for 3000/4000/5000/7000/9000)
Allowed: TWFT_NONE, TWFT_RED, TWFT_GREEN, TWFT_BLUE
Default: TWFT_NONE
- Capability is only available for TWPT_BW or (on some systems) TWPT_GRAY.
- Selects the color that will be filtered.
ICAP_FILTERPROCESSING Custom: i600 Series
Allowed: TWFP_NORMAL, TWFP_LOWRES
Default: TWFP_NORMAL
- If color dropout at low resolutions results in unwanted artifacts, try changing this capability to TWFP_LOWRES
ICAP_FILTERTHRESHOLD Custom: All Models (except for 900/3000/5000/7000/9000/i2000/i2900/i3000/i4000/i5000)
Allowed: 0 - 255
Default: 175
- Capability is only available for TWPT_BW or (on some systems) TWPT_GRAY.
- Specified the threshold past which color filtering will be applied.
ICAP_FLASHUSED Unsupported.
ICAP_FLASHUSED2 Unsupported.
ICAP_FLIPBACKGROUNDCOLOR Custom: 5000/7000
Allowed: FALSE, TRUE
Default: FALSE
- If TRUE then the background color on the left and right of the image will be reversed from black to white (or white to black).
ICAP_FLIPROTATION Unsupported.
ICAP_FORCECOMPRESSION Custom: 3000/4000/5000/7000/9000/i600/i700/i800/i1800
Allowed: TWCP_NONE, TWCP_GROUP4, TWCP_JPEG
Default: TWCP_NONE
- Force Compression is ignored if the value of ICAP_COMPRESSION for the same camera is any value but TWCP_NONE.
- TWCP_NONE, TWCP_GROUP4 only for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW).
- TWCP_NONE, TWCP_JPEG only for /Camera_Color_Both, /Camera_Color_Top and /Camera_Color_Bottom (ICAP_PIXELTYPE == TWPT_RGB or TWPT_GRAY).
ICAP_FOREGROUNDBOLDNESSAGGRESSIVENESS
Custom: i2900/i3000
Allowed: -10 to 10
Default: 0
- The foreground boldness aggressiveness.
- Only available for color/gray cameras.
- Only has meaning if ICAP_FOREGROUNDBOLDNESSMODE
is TWFB_AUTOMATIC.
ICAP_FOREGROUNDBOLDNESSMODE
Custom: i2900/i3000
Allowed: TWFB_NONE,TWFB_AUTOMATICBASIC,TWFB_AUTOMATIC
Default: TWFB_NONE
- The foreground boldness mode.
- Only available for color/gray cameras.
ICAP_FRAMELENGTHCONTROL Custom: 5000/7000 Series
Allowed: FALSE, TRUE
Default: TRUE
- Set to FALSE if scanning documents that have ragged bottom edges that are not otherwise scanned properly.
ICAP_FRAMES Standard: All Models
Allowed: 1 frame per camera within the boundaries set by the min and max width and length capabilities
Default: the values associated with ICAP_SUPPORTEDSIZES TWSS_ISOA4.
- Please refer to the Width and Length Alignment section of faq.htm for more information.
ICAP_FRAMESANGLE Custom:
i2000/i2900/i3000/i4000/i5000
Allowed: 1 frame per camera within the boundaries set by the min and max width
and length capabilities
Default: the values associated with ICAP_SUPPORTEDSIZES TWSS_ISOA4.
- This capability is the same as ICAP_FRAMES except it includes angle.
ICAP_GAMMA Unsupported.
ICAP_GAMMAENABLED Custom: i600/i700/i800/i1800/i2000/i2900/i3000/i4000/i5000
Allowed: FALSE, TRUE
Default: TRUE
- A value of TRUE causes the scanner to apply its gamma table to the image. This only has meaning for the grayscale output.
ICAP_GRAYSCALE Custom: All Models (except for 3000/4000/5000/7000/9000)
Allowed: FALSE, TRUE
Default: FALSE
- Modifies the output of the associated color camera to be grayscale content only.
- Only for /Camera_Color_Both, /Camera_Color_Top and /Camera_Color_Bottom
- For i610 this is read only and TRUE.
- Please see the ICAP_PIXELTYPE section of faq.htm.
ICAP_HALFTONES Standard: All Models
Allowed: “Auto ATP” iThresholding (All models except for 3000/4000/5000/7000/9000)
“Adaptive Thresholding” ATP
“Fixed Thresholding”
“64-Level Bayer Dither”
“64-Level 45-Degree Cluster Dot”
“64-Level Disperse Dot”
“Error Diffusion” (i800 only)
“ChromaTHR(TM)” (3590/4500 only)
“Diffusion: 3 Screen” (i800 only)
“Diffusion: 16 Screen” (i800 only)
“Diffusion: 32 Screen” (i800 only)
“Diffusion: 64 Screen” (i800 only)
“Diffusion: 4 Bayer” (i800 only)
“Diffusion: 16 Bayer” (i800 only)
“Diffusion: 64 Bayer” (i800 only)
“3-Level Screen”
“16-Level Screen”
“32-Level Screen”
“64-Level Screen”
“4-Level Bayer Dither”
“16-Level Bayer Dither”
i600/i700/i900/i1100/i1200/i1300/i1400/i1800/i2900/i3000/i4000/i5000:
“Auto ATP” iThresholding
“Adaptive Thresholding” ATP
“Fixed Thresholding”
Default: 3000/4000/5000/7000/9000: "Adaptive Thresholding"
Other: “Auto ATP”
- Halftones are not easily represented within TWAIN since the number of algorithms is too large and varied to accommodate any simple system of classification. To properly represent halftones an application must present the array of TW_STR32s to the user as-is, with no attempt at interpreting the data.
- Capability is only available for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW).
ICAP_HALFTONESQUALITY Custom: 3590/4500 Series
Allowed (no THR2(tm) card): TWHQ_SOFTWAREFAST, TWHQ_SOFTWAREBEST
Allowed (THR2(tm) card): TWHQ_HARDWAREBEST
Default (no THR2(tm) card): TWHQ_SOFTWAREFAST
Default (THR2(tm) card): TWHQ_HARDWAREBEST
- Determiners the ChromaTHR(tm) algorithm to be used to binarize the color data from the scanner.
ICAP_HIGHLIGHT Unsupported.
ICAP_HOLEFILLENABLED Custom: i1200/i1300/i2000/i2900/i3000
Allowed: FALSE, TRUE
Default: FALSE
- Hole Fill enabled/disabled. If TRUE, then remove “punch holes” in the original document from the resultant image.
ICAP_IMAGEDATASET Unsupported.
ICAP_IMAGEEDGEBOTTOM Custom: i30/i40/i55/i65/i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000
Allowed: 0 to ICAP_PHYSICALHEIGHT
Default: 0
- Amount of fill for the bottom edge of the image.
ICAP_IMAGEEDGEFILL Custom: i30/i40/i55/i65/i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000
Allowed: TWIE_NONE, TWIE_AUTOMATIC, TWIE_AUTOMATICWITHTEAR, TWIE_WHITE, TWIE_BLACK
Default: TWIE_AUTOMATIC if the scanner is supported. Otherwise TWIE_NONE is the default
- Fill in each edge of the image with the selected color.
- The TWIE_AUTOMATIC and TWIE_AUTOMATICWITHTEAR are not available for all scanners.
ICAP_IMAGEEDGEFILLALLSIDES Custom: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000
Allowed: TRUE/FALSE
Default: TRUE
- Amount of fill for the all size the same as top edge of the image.
ICAP_IMAGEEDGELEFT Custom: i30/i40/i55/i65/i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000
Allowed: 0 to ICAP_PHYSICALWIDTH
Default: 0
- Amount of fill for the left edge of the image.
ICAP_IMAGEEDGERIGHT Custom: i30/i40/i55/i65/i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000
Allowed: 0 to ICAP_PHYSICALWIDTH
Default: 0
- Amount of fill for the right edge of the image.
ICAP_IMAGEEDGETOP Custom: i30/i40/i55/i65/i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000
Allowed: 0 to ICAP_PHYSICALHEIGHT
Default: 0
- Amount of fill for the top edge of the image.
ICAP_IMAGEFILEFORMAT Standard: All Models
Allowed: TWFF_BMP, TWFF_TIFF, TWFF_JFIF
Default: TWFF_BMP
- TWFF_BMP, TWFF_TIFF only for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW). If compression is used then only TWFF_TIFF is allowed.
- TWFF_BMP, TWFF_TIFF, TWFF_JFIF only for /Camera_Color_Both, /Camera_Color_Top and /Camera_Color_Bottom (ICAP_PIXELTYPE == TWPT_RGB or TWPT_GRAY). If compression is used then only TWFF_TIFF and TWFF_JFIF are allowed.
- TWFF_TIFF uses the following tags: NewSubFileType, SubFileType, ImageWidth, ImageLength, BitsPerSample, Compression, PhotometricInterpretation, FillOrder, StripOffsets, SamplesPerPixel, RowsPerStrip, StripByteCounts, XResolution, YResolution, T4Options, T6Options, ResolutionUnits.
- Please note, TWFF_TIFF with an ICAP_COMPRESSION of TWCP_JPEG results in a JPEG TIFF file, which is still currently not a well defined or supported format (the Source is currently following the TIFF 7 guidelines).
ICAP_IMAGEFILTER Standard: All Models (except for 3000/4000)
Allowed: TWIF_NONE, TWIF_LOWPASS
Default: TWIF_NONE
- Capability is only available for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW).
ICAP_IMAGEMERGE Standard: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000
Allowed: TWIM_NONE, TWIM_FRONTONTOP, TWIM_FRONTONBOTTOM, TWIM_FRONTONLEFT, TWIM_FRONTONRIGHT
Default: TWIM_NONE
- Merges the front and back images into a single image that is returned to the application.
ICAP_IMAGEMERGEHEIGHTTHRESHOLD
Unsupported.
ICAP_JPEGPIXELTYPE Standard: All Models (except for 5000/7000/9000)
Allowed: TWPT_YUV
Default: TWPT_YUV
- Capability is only available for ICAP_PIXELTYPE == TWPT_RGB or TWPT_GRAY and ICAP_COMPRESSION == TWCP_JPEG.
ICAP_JPEGQUALITY Standard: All Models (except for 5000/7000/9000)
Allowed: 0 to 100 in steps of 5
Default: 50
- This is TWAIN 1.9 capability.
- Generally speaking, selecting higher values will result in better quality at the cost of larger compressed JPEG files.
ICAP_LAMPSAVER Custom: 3000/4000/i800 Series
Allowed: FALSE, TRUE
Default: TRUE
- This is a custom capability.
- Turning this capability on will allow the scanner to turn off the lamps after ten minutes of inactivity, which extends lamp life and reduces energy consumption.
ICAP_LAMPSTATE Unsupported.
ICAP_LAMPTIMEOUT Custom: 3000/4000/i800 Series
Allowed 3000/4000: 0 (disabled), 10
Allowed i800: 0 (disabled) - 30
Default 3000/4000: 10
Default i800: 20
- This is a custom capability.
- Turning this capability on will allow the scanner to turn off the lamps after ten minutes of inactivity, which extends lamp life and reduces energy consumption.
ICAP_LIGHTPATH Unsupported.
ICAP_LIGHTSOURCE Unsupported.
ICAP_MAXFRAMES Standard: All Models (Except for i2000/i2900/i3000/i4000/i5000)
Allowed: 1
Default: 1
- This is a read-only capability.
ICAP_MEDIATYPE Standard: i900/i1100/i1200/i1300/i1400/i2000/i2900/i3000/i4000/i5000
Allowed: TWMT_CARDSTOCK, TWMT_GLOSSYPAPER, TWMT_MAGAZINE, TWMT_PLAINPAPER, TWMT_THINPAPER
Default: TWMT_PLAINPAPER
- Allows user to select type of media being scanned. The front and rear camera setting must be the same.
ICAP_MINIMUMHEIGHT Standard: All Models
Allowed: 3000/4000/5000/7000/9000/i800: 2.5"
Other: 1”
Default: (same as allowed)
- This is a read-only capability.
ICAP_MINIMUMWIDTH Standard: All Models
Allowed: 3000/4000/5000/7000/9000/i800: 2.5"
Other: 1”
Default: (same as allowed)
- This is a read-only capability.
ICAP_NOISEFILTER Standard: All Models
Allowed: TWNF_NONE, TWNF_LONEPIXEL, TWNF_MAJORITYRULE
Default: i2000/i2900/i3000/i4000/i5000: TWNF_LONEPIXEL
Other: TWNF_NONE
- Capability is only available for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW).
- TWNF_MAJORITYRULE is not available on the 9xxx Series.
ICAP_ORIENTATION Standard: All Models
Allowed: TWOR_PORTRAIT, TWOR_LANDSCAPE
Default: TWOR_PORTRAIT
- Please note, that as per the specification, ICAP_ORIENTATION does not change the values of ICAP_FRAMES or DAT_IMAGELAYOUT. What it does is affect the interpretation of these values at the time they are downloaded to the device. TWOR_PORTRAIT leaves them unmodified. TWOR_LANDSCAPE flips the x and y offsets and the width and height. If ICAP_SUPPORTEDSIZES is not equal to TWSS_NONE, then the x-offset will be recalculated to center the landscaped image.
ICAP_ORTHOGONALROTATE Custom: i2000/i2900/i3000/i5000
Allowed: TWOROT_NONE, TWOROT_AUTOMATIC, TWOROT_90, TWOROT_180, TWOROT_270,
TWOROT_AUTOMATIC_90, TWOROT_AUTOMATIC_180, TWOROT_AUTOMATIC_270
Default: TWOROT_NONE
- Orthogonal rotation.
ICAP_OVERSCAN Standard: All Models (except for 5000/7000/9000)
Allowed: TWOV_NONE, TWOV_TOPBOTTOM, TWOV_LEFTRIGHT, TWOV_ALL
Default: TWOV_NONE
ICAP_OVERSCANX Custom: All Models (except for 5000/7000/9000)
Allowed: see below
Default: 0.5" or 0.375"
- This capability controls the amount of overscan to add on the left and right sides of the frame.
- 3500 supports 0 to 0.5"
- All others support 0 to 0.375"
ICAP_OVERSCANY Custom: All Models (except for 5000/7000/9000)
Allowed: see below
Default: 0.5" or 0.375"
- This capability controls the amount of overscan to add on the top and bottom sides of the frame.
- 3500 supports 0 to 0.5"
- All others support 0 to 0.375"
ICAP_PATCHCODEDETECTIONENABLED
Standard: i800/i1800 Series
Allowed: FALSE, TRUE
Default: FALSE
- If TRUE then the requested patch codes will be detected by the scanner.
ICAP_PATCHCODEMAXRETRIES Standard: i800/i1800 Series
Allowed: 1
Default: 1
- Maximum retries allowed.
- This is a read-only capability.
ICAP_PATCHCODEMAXSEARCHPRIORITIES
Standard: i800/i1800 Series
Allowed: 5
Default: 5
- Number kinds of patch codes detected.
- This is a read-only capability.
ICAP_PATCHCODESEARCHMODE Standard: i800/i1800 Series
Allowed: TWBD_VERT
Default: TWBD_VERT
- Orientation of the patch codes.
- This is a read-only capability.
ICAP_PATCHCODESEARCHPRIORITIES
Standard: i800/i1800 Series
Allowed: TWPCH_PATCH1, TWPCH_PATCH2, TWPCH_PATCH3, TWPCH_PATCH4,
TWPCH_PATCH6, TWPCH_PATCHT2, TWPCH_PATCHT3
Default: TWPCH_PATCH2
- Patch codes we are searching for.
ICAP_PATCHCODETIMEOUT Standard: i800/i1800 Series
Allowed: 1
Default: 1
- Amount of time till attempt fails.
- This is a read-only capability.
ICAP_PHYSICALHEIGHT Standard: All Models
Allowed 3000/4000: 26"
5000/7000/9000/i800: 30"
i30/i40: 14.27” or 34''
i100: 17" w/ 64MB or 128MB, 32" w/ more
i200: 17" w/ 64MB, 26” w/ 128MB, 32" w/ more or 34'' w/ Long Document
i55/i65/i600/i700/i1100/i1200/i1300/i1400/i1800: 34”
Other: Scanner specific
Default: (same as allowed)
- This is a read-only capability.
- The driver captures some extra data to reduce clipping, see the product specification for more information on the scanning dimensions.
ICAP_PHYSICALHEIGHTADJUST Custom: i2000/i2900/i3000/i4000/i5000
Allowed: Scanner specific
Default: Scanner specific
- Adjusts the value of ICAP_PHYSICALHEIGHT. Applications must set this value to have access to the full scan length of the ADF.
ICAP_PHYSICALWIDTH Standard: All Models
Allowed i30/i40: 8.767”
i55/i65: 8.64''
i1200/i1300: 8.75''
i1100: 8.76''
Other: 12"
Default: (same as allowed)
- This is a read-only capability.
- The driver captures some extra data to reduce clipping, see the product specification for more information on the scanning dimensions.
ICAP_PIXELFLAVOR Standard: All Models
Allowed: TWPF_CHOCOLATE, TWPF_VANILLA
Default: TWPF_CHOCOLATE
- This capability is supported for ICAP_PIXELTYPE == TWPT_RGB or TWPT_GRAY since it is a required capability in the TWAIN specification, but in the case of the color camera, the value is ignored.
ICAP_PIXELFLAVORCODES Standard: All Models
Allowed: TWPF_CHOCOLATE, TWPF_VANILLA
Default: TWPF_CHOCOLATE
- Specifies whether the compressed codes’ pixel “sense” will be inverted from the Current value of ICAP_PIXELFLAVOR prior to transfer
- Capability is only available for ICAP_PIXELTYPE == TWPT_BW and ICAP_COMPRESSION ==TWCP_GROUP4.
ICAP_PIXELTYPE Standard: All Models
Allowed: TWPT_BW, TWPT_RGB, TWPT_GRAY
Default: TWPT_BW prior to 4.x, after 4.x TWPT_RGB for color cameras, TWPT_BW for bitonal cameras.
- TWPT_BW only for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW).
- TWPT_RGB only for /Camera_Color_Both, /Camera_Color_Top and /Camera_Color_Bottom (ICAP_PIXELTYPE == TWPT_RGB or TWPT_GRAY).
- Prior to 4.x, changing ICAP_PIXELTYPE is the same as using DAT_FILESYSTEM / MSG_CHANGEDIRECTORY to select between the /Camera_Bitonal_Both and /Camera_Color_Both cameras.
- TWPT_RGB is not available for i610. Default for this model is TWPT_GRAY.
- Please see the ICAP_PIXELTYPE section of faq.htm.
ICAP_PLANARCHUNKY Standard: All Models
Allowed: TWPC_PLANAR, TWPC_CHUNKY
Default: TWPC_CHUNKY
- This is kind of a weird capability for a pixel type of TWPT_BW to have to worry about, but this is listed as a mandatory capability, so here it is.
- TWPC_PLANAR or TW_PC_CHUNKY for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW).
- TW_PC_CHUNKY only for /Camera_Color_Both, /Camera_Color_Top and /Camera_Color_Bottom (ICAP_PIXELTYPE == TWPT_RGB and ICAP_PIXELTYPE == TWPT_GRAY).
ICAP_ROTATION Standard: All Models (except for i30/i40/i55/i65/3000/4000/5000/7000/9000)
Allowed: 0, 90, 180, 270, 360 (except i600)
Default: 0
ICAP_SHADOW Unsupported.
ICAP_SKEWANGLE Custom: i900/i1100/i1200/i2900/i3000/i1300/i1400/i2000/i4000/i5000
Allowed: -360000 - 360000
Default: 0
- Selects the deskew angle for fixed cropping.
ICAP_STREAKREMOVALAGGRESSIVENESS
Custom: i1200/i1300/i2000/i2900/i3000/i4000/i5000
Allowed: -2 to 2
Default: 0
- Streak removal aggressiveness level. -2 is least aggressive while 2 is most aggressive.
- The aggressiveness level is meaningless if streak removal ‘enabled’ is FALSE.
ICAP_STREAKREMOVALENABLED Custom: i1200/i1300/i2000/i2900/i3000/i4000/i5000
Allowed: FALSE, TRUE
Default: i1200/i1300: FALSE
Other: TRUE
- Streak Removal enabled/disabled. If TRUE, then the streak removal ‘aggressiveness level’ has meaning.
ICAP_SUPPORTEDBARCODETYPES
Unsupported.
ICAP_SUPPORTEDEXTIMAGEINFO Standard: i2000/i2900/i3000/i5000
Allowed: All supported extended image info
Default: (same as allowed)
- Lists all of the information that the Source is capable of returning from a call to DAT_EXTIMAGEINFO
- This is a read-only capability.
ICAP_SUPPORTEDPATCHCODETYPES
Standard: i800/i1800 Series
Allowed: TWPCH_PATCH1, TWPCH_PATCH2, TWPCH_PATCH3, TWPCH_PATCH4,
TWPCH_PATCH6, TWPCH_PATCHT2, TWPCH_PATCHT3
- This is a read only capability.
ICAP_THRESHOLD Standard: All Models
Allowed: 0 to 255
Default: 90
- Capability is only available for /Camera_Bitonal_Both, /Camera_Bitonal_Top and /Camera_Bitonal_Bottom (ICAP_PIXELTYPE == TWPT_BW).
ICAP_TILES Unsupported.
ICAP_TIMEFILL Unsupported.
ICAP_UNDEFINEDIMAGESIZE Standard: All Models (Except for i2000/i2900/i3000/i4000/i5000)
Allowed: FALSE, TRUE
Default: FALSE
- There is no performance benefit from setting this value to TRUE.
ICAP_UNITS Standard: All Models
Allowed: TWUN_INCHES, TWUN_CENTIMETERS, TWUN_PICAS, TWUN_POINTS, TWUN_TWIPS, TWUN_PIXELS
- It is advised that ICAP_UNITS be set to TWUN_PIXELS any time the Application desires to know the exact dimensions of an image.
- Selecting TWUN_PIXELS will cause ICAP_XRESOLUTION, ICAP_YRESOLUTION, ICAP_XNATIVERESOLUTION and ICAP_YNATIVERESOLUTION to report their values as percentages up from the smallest resolution supported by the current camera. For instance, if the current camera supported 200 and 300 DPI, it will report 1.0 and 1.5 when in TWUN_PIXELS.
ICAP_XFERMECH Standard: All Models
Allowed: TWSX_NATIVE, TWSX_FILE, TWSX_MEMORY
Default: TWSX_NATIVE
- The Source is designed so that TWSX_MEMORY is the most efficient transfer available. All performance benchmarks apply to this transfer mechanism, and may be less with the other options.
- TWSX_NATIVE transfers are less efficient than TWSX_MEMORY transfers because they require the Source to flip the image around the x-axis to meet the requirements of BITMAPs.
- TWSX_NATIVE transfers are less efficient with color images than TWSX_MEMORY transfers because they require the Source to convert each color pixel from RGB to BGR.
- Native transfers cannot be used with CCITT compressions.
- Compression is supported for image transfers of TWSX_FILE with an image file format of TWFF_TIFF.
- On JPEG compression is supported for image transfers of TWSX_FILE with an image file format of TWFF_TIFF (see faq.htm for more info) and TWFF_JFIF.
- The Source incorrectly allows CCITT compression with an image transfer of TWSX_FILE and an image file format of TWFF_BMP.
ICAP_XNATIVERESOLUTION Standard: All Models
Allowed: (scanner specific)
Default: (scanner specific)
- This is a read-only capability.
- i100/i200/i600/i700/i800/i1800 support 300 only.
- 3500/3510/3520 support 200 and 300, with the current value reflecting the setting of ICAP_XRESOLUTION.
- 3590/4500 supports 200 and 300 for bitonal, and 100 and 150 for color, with the current value reflecting the setting of ICAP_XRESOLUTION.
- Other support 600 only.
ICAP_XRESOLUTION Standard: All Models
Allowed: (scanner specific)
Default: 200
- ICAP_XRESOLUTION always matches the current ICAP_YRESOLUTION value. Changing one changes the other.
- 3500/3510/3520 support 200 and 300, with the current value reflecting the setting of ICAP_XRESOLUTION.
- 3590 supports 200 and 300 for bitonal, and 100 and 150 for color, with the current value reflecting the setting of ICAP_XRESOLUTION.
- On the 3590/4500 the resolutions for the bitonal and color cameras are linked because of the transport speed. This means that a bitonal resolution of 200 requires a color resolution of 100, and a bitonal resolution of 300 requires a color resolution of 150. The Source enforces this behavior, changing the bitonal and color resolutions as appropriate to keep these values in sync.
- 900/500 support 70 - 400 in steps of 10.
- 990 supports 70 - 200 in steps of 10.
- All other 5000/7000/9000 Series support 70 - 300 in steps of 10.
- i30/i40/i55/i65/i100/i200 support: 75, 100, 150, 200, 240, 300, 400, 600.
- i600/i700/i1800 support for color: 100, 150, 200, 240, 300. And for bitonal: 200, 240, 300, 400.
- i800 support for color: 100, 150, 200, 300. And for bitonal: 200, 240, 300, 400.
- i1100/i1200/i1300/i1400 support: 75, 100, 150, 200, 240, 300, 400, 600,1200.
- i4000/i5000 support: 100, 150, 200, 240, 300, 400, 600.
- i2000 support: 75, 100, 150, 200, 240, 250, 300, 400, 600, 1200.
- i900 support:
100, 150, 200, 240, 250, 300, 400, 600, 1200.
- i2900 support: 100, 150, 200, 240, 250, 300, 400, 600, 1200.
- i3000 support: 100, 150, 200, 240, 250, 300, 400, 600, 1200.
ICAP_XSCALING Unsupported.
ICAP_YNATIVERESOLUTION Standard: All Models
Allowed: (scanner specific)
Default: (scanner specific)
- This is a read-only capability.
- i100/i200/i600/i700/i800/i1800 support 300 only.
- 3500/3510/3520 support 200 and 300, with the current value reflecting the setting of ICAP_YRESOLUTION.
- 3590/4500 supports 200 and 300 for bitonal, and 100 and 150 for color, with the current value reflecting the setting of ICAP_YRESOLUTION.
- Other support 600 only.
ICAP_YRESOLUTION Standard: All Models
Allowed: (scanner specific)
Default: 200
- ICAP_XRESOLUTION always matches the current ICAP_YRESOLUTION value. Changing one changes the other.
- 3500/3510/3520 support 200 and 300, with the current value reflecting the setting of ICAP_XRESOLUTION.
- 3590 supports 200 and 300 for bitonal, and 100 and 150 for color, with the current value reflecting the setting of ICAP_XRESOLUTION.
- On the 3590/4500 the resolutions for the bitonal and color cameras are linked because of the transport speed. This means that a bitonal resolution of 200 requires a color resolution of 100, and a bitonal resolution of 300 requires a color resolution of 150. The Source enforces this behavior, changing the bitonal and color resolutions as appropriate to keep these values in sync.
- 900/500 support 70 - 400 in steps of 10.
- 990 supports 70 - 200 in steps of 10.
- All other 5000/7000/9000 Series support 70 - 300 in steps of 10.
- i30/i40/i55/i65/i100/i200 support: 75, 100, 150, 200, 240, 300, 400, 600.
- i600/i700/i1800 support for color: 100, 150, 200, 240, 300. And for bitonal: 200, 240, 300, 400.
- i800 support for color: 100, 150, 200, 300. And for bitonal: 200, 240, 300, 400.
- i1100/i1200/i1300/i1400 support: 75, 100, 150, 200, 240, 300, 400, 600,1200.
- i4000/i5000 support: 100, 150, 200, 240, 300, 400, 600.
- i2000 support: 75, 100, 150, 200, 240, 250, 300, 400, 600, 1200.
- i900 support: 100, 150, 200, 240, 250, 300, 400, 600, 1200.
- i2900 support: 100, 150, 200, 240, 250, 300, 400, 600, 1200.
- i3000 support: 100, 150, 200, 240, 250, 300, 400, 600, 1200.
ICAP_YSCALING Unsupported.
ICAP_ZOOMFACTOR Unsupported.


| |
ActiveTcl User Guide
|
|
|
- NAME
- grid - Geometry manager that arranges widgets in a grid
- SYNOPSIS
- grid option arg ?arg ...?

- RELATIVE PLACEMENT
- -
- x
- ^
- THE GRID ALGORITHM
- GEOMETRY
PROPAGATION
- RESTRICTIONS ON MASTER
WINDOWS
- STACKING ORDER
- CREDITS
- KEYWORDS
grid - Geometry manager that arranges widgets in a grid
grid option arg ?arg ...?
The grid command is used to communicate with the grid
geometry manager that arranges widgets in rows and columns inside
of another window, called the geometry master (or master window).
The grid command can have any of several forms, depending on
the option argument:
- grid slave ?slave ...?
?options?
- If the first argument to grid is suitable as the first
slave argument to grid configure, either a window name (any
value starting with .) or one of the characters x or
^ (see the ``RELATIVE PLACEMENT'' section below), then the
command is processed in the same way as grid configure.
- grid bbox master ?column row?
?column2 row2?
- With no arguments, the bounding box (in pixels) of the grid is
returned. The return value consists of 4 integers. The first two
are the pixel offset from the master window (x then y) of the
top-left corner of the grid, and the second two integers are the
width and height of the grid, also in pixels. If a single
column and row is specified on the command line, then
the bounding box for that cell is returned, where the top left cell
is numbered from zero. If both column and row
arguments are specified, then the bounding box spanning the rows
and columns indicated is returned.
- grid columnconfigure master index
?-option value...?
- Query or set the column properties of the index column
of the geometry master, master. The valid options are
-minsize, -weight, -uniform and -pad.
If one or more options are provided, then index may be given
as a list of column indeces to which the configuration options will
operate on. The -minsize option sets the minimum size, in
screen units, that will be permitted for this column. The
-weight option (an integer value) sets the relative weight
for apportioning any extra spaces among columns. A weight of zero
(0) indicates the column will not deviate from its requested size.
A column whose weight is two will grow at twice the rate as a
column of weight one when extra space is allocated to the layout.
The -uniform option, when a non-empty value is supplied,
places the column in a uniform group with other columns that
have the same value for -uniform. The space for columns
belonging to a uniform group is allocated so that their sizes are
always in strict proportion to their -weight values. See
``THE GRID ALGORITHM'' below for further details. The -pad
option specifies the number of screen units that will be added to
the largest window contained completely in that column when the
grid geometry manager requests a size from the containing window.
If only an option is specified, with no value, the current value of
that option is returned. If only the master window and index is
specified, all the current settings are returned in an list of
"-option value" pairs.
- grid configure slave ?slave
...? ?options?
- The arguments consist of the names of one or more slave windows
followed by pairs of arguments that specify how to manage the
slaves. The characters -, x and ^, can be
specified instead of a window name to alter the default location of
a slave, as described in the ``RELATIVE PLACEMENT'' section,
below. The following options are supported:
- -column n
- Insert the slave so that it occupies the nth column in
the grid. Column numbers start with 0. If this option is not
supplied, then the slave is arranged just to the right of previous
slave specified on this call to grid, or column "0" if it is
the first slave. For each x that immediately precedes the
slave, the column position is incremented by one. Thus the
x represents a blank column for this row in the grid.
- -columnspan n
- Insert the slave so that it occupies n columns in the
grid. The default is one column, unless the window name is followed
by a -, in which case the columnspan is incremented once for
each immediately following -.
- -in other
- Insert the slave(s) in the master window given by other.
The default is the first slave's parent window.
- -ipadx amount
- The amount specifies how much horizontal internal
padding to leave on each side of the slave(s). This is space is
added inside the slave(s) border. The amount must be a valid
screen distance, such as 2 or .5c. It defaults to
0.
- -ipady amount
- The amount specifies how much vertical internal padding
to leave on on the top and bottom of the slave(s). This space is
added inside the slave(s) border. The amount defaults to
0.
- -padx amount
- The amount specifies how much horizontal external
padding to leave on each side of the slave(s), in screen units.
Amount may be a list of two values to specify padding for
left and right separately. The amount defaults to 0. This
space is added outside the slave(s) border.
- -pady amount
- The amount specifies how much vertical external padding
to leave on the top and bottom of the slave(s), in screen units.
Amount may be a list of two values to specify padding for
top and bottom separately. The amount defaults to 0. This
space is added outside the slave(s) border.
- -row n
- Insert the slave so that it occupies the nth row in the
grid. Row numbers start with 0. If this option is not supplied,
then the slave is arranged on the same row as the previous slave
specified on this call to grid, or the first unoccupied row
if this is the first slave.
- -rowspan n
- Insert the slave so that it occupies n rows in the grid.
The default is one row. If the next grid command contains
^ characters instead of slaves that line up with the
columns of this slave, then the rowspan of this
slave is extended by one.
- -sticky style
- If a slave's cell is larger than its requested dimensions, this
option may be used to position (or stretch) the slave within its
cell. Style is a string that contains zero or more of the
characters n, s, e or w. The string can
optionally contains spaces or commas, but they are ignored. Each
letter refers to a side (north, south, east, or west) that the
slave will "stick" to. If both n and s (or e
and w) are specified, the slave will be stretched to fill
the entire height (or width) of its cavity. The sticky
option subsumes the combination of -anchor and -fill
that is used by pack. The
default is {}, which causes the slave to be centered in its
cavity, at its requested size.
If any of the slaves are already managed by the geometry manager
then any unspecified options for them retain their previous values
rather than receiving default values.
- grid forget slave ?slave
...?
- Removes each of the slaves from grid for its master and
unmaps their windows. The slaves will no longer be managed by the
grid geometry manager. The configuration options for that window
are forgotten, so that if the slave is managed once more by the
grid geometry manager, the initial default settings are used.
- grid info slave
- Returns a list whose elements are the current configuration
state of the slave given by slave in the same option-value
form that might be specified to grid configure. The first
two elements of the list are ``-in master'' where
master is the slave's master.
- grid location master x y
- Given x and y values in screen units relative to
the master window, the column and row number at that x and
y location is returned. For locations that are above or to
the left of the grid, -1 is returned.
- grid propagate master
?boolean?
- If boolean has a true boolean value such as 1 or
on then propagation is enabled for master, which must
be a window name (see ``GEOMETRY PROPAGATION'' below). If
boolean has a false boolean value then propagation is
disabled for master. In either of these cases an empty
string is returned. If boolean is omitted then the command
returns 0 or 1 to indicate whether propagation is
currently enabled for master. Propagation is enabled by
default.
- grid rowconfigure master index
?-option value...?
- Query or set the row properties of the index row of the
geometry master, master. The valid options are
-minsize, -weight, -uniform and -pad.
If one or more options are provided, then index may be given
as a list of row indeces to which the configuration options will
operate on. The -minsize option sets the minimum size, in
screen units, that will be permitted for this row. The
-weight option (an integer value) sets the relative weight
for apportioning any extra spaces among rows. A weight of zero (0)
indicates the row will not deviate from its requested size. A row
whose weight is two will grow at twice the rate as a row of weight
one when extra space is allocated to the layout. The
-uniform option, when a non-empty value is supplied, places
the row in a uniform group with other rows that have the
same value for -uniform. The space for rows belonging to a
uniform group is allocated so that their sizes are always in strict
proportion to their -weight values. See ``THE GRID
ALGORITHM'' below for further details. The -pad option
specifies the number of screen units that will be added to the
largest window contained completely in that row when the grid
geometry manager requests a size from the containing window. If
only an option is specified, with no value, the current value of
that option is returned. If only the master window and index is
specified, all the current settings are returned in an list of
"-option value" pairs.
- grid remove slave ?slave
...?
- Removes each of the slaves from grid for its master and
unmaps their windows. The slaves will no longer be managed by the
grid geometry manager. However, the configuration options for that
window are remembered, so that if the slave is managed once more by
the grid geometry manager, the previous values are retained.
- grid size master
- Returns the size of the grid (in columns then rows) for
master. The size is determined either by the slave
occupying the largest row or column, or the largest column or row
with a minsize, weight, or pad that is
non-zero.
- grid slaves master ?-option
value?
- If no options are supplied, a list of all of the slaves in
master are returned, most recently manages first.
Option can be either -row or -column which
causes only the slaves in the row (or column) specified by
value to be returned.
The grid command contains a limited set of capabilities
that permit layouts to be created without specifying the row and
column information for each slave. This permits slaves to be
rearranged, added, or removed without the need to explicitly
specify row and column information. When no column or row
information is specified for a slave, default values are
chosen for column, row, columnspan and
rowspan at the time the slave is managed. The values
are chosen based upon the current layout of the grid, the position
of the slave relative to other slaves in the same
grid command, and the presence of the characters -,
x, and ^ in grid command where slave
names are normally expected.
- -
- This increases the columnspan of the slave to the left.
Several -'s in a row will successively increase the
columnspan. A - may not follow a ^ or a x, nor
may it be the first slave argument to grid
configure.
- x
- This leaves an empty column between the slave on the
left and the slave on the right.
- ^
- This extends the rowspan of the slave above the
^'s in the grid. The number of ^'s in a row must
match the number of columns spanned by the slave above
it.
The grid geometry manager lays out its slaves in three steps. In
the first step, the minimum size needed to fit all of the slaves is
computed, then (if propagation is turned on), a request is made of
the master window to become that size. In the second step, the
requested size is compared against the actual size of the master.
If the sizes are different, then spaces is added to or taken away
from the layout as needed. For the final step, each slave is
positioned in its row(s) and column(s) based on the setting of its
sticky flag.
To compute the minimum size of a layout, the grid geometry
manager first looks at all slaves whose columnspan and rowspan
values are one, and computes the nominal size of each row or column
to be either the minsize for that row or column, or the sum
of the padding plus the size of the largest slave, whichever
is greater. After that the rows or columns in each uniform group
adapt to each other. Then the slaves whose rowspans or columnspans
are greater than one are examined. If a group of rows or columns
need to be increased in size in order to accommodate these slaves,
then extra space is added to each row or column in the group
according to its weight. For each group whose weights are
all zero, the additional space is apportioned equally.
When multiple rows or columns belong to a uniform group, the
space allocated to them is always in proportion to their weights.
(A weight of zero is considered to be 1.) In other words, a row or
column configured with -weight 1 -uniform a will have
exactly the same size as any other row or column configured with
-weight 1 -uniform a. A row or column configured with
-weight 2 -uniform b will be exactly twice as large as one
that is configured with -weight 1 -uniform b.
More technically, each row or column in the group will have a
size equal to k*weight for some constant k. The
constant k is chosen so that no row or column becomes
smaller than its minimum size. For example, if all rows or columns
in a group have the same weight, then each row or column will have
the same size as the largest row or column in the group.
For masters whose size is larger than the requested layout, the
additional space is apportioned according to the row and column
weights. If all of the weights are zero, the layout is centered
within its master. For masters whose size is smaller than the
requested layout, space is taken away from columns and rows
according to their weights. However, once a column or row shrinks
to its minsize, its weight is taken to be zero. If more space needs
to be removed from a layout than would be permitted, as when all
the rows or columns are at there minimum sizes, the layout is
clipped on the bottom and right.
The grid geometry manager normally computes how large a master
must be to just exactly meet the needs of its slaves, and it sets
the requested width and height of the master to these dimensions.
This causes geometry information to propagate up through a window
hierarchy to a top-level window so that the entire sub-tree sizes
itself to fit the needs of the leaf windows. However, the grid
propagate command may be used to turn off propagation for one
or more masters. If propagation is disabled then grid will not set
the requested width and height of the master window. This may be
useful if, for example, you wish for a master window to have a
fixed size that you specify.
The master for each slave must either be the slave's parent (the
default) or a descendant of the slave's parent. This restriction is
necessary to guarantee that the slave can be placed over any part
of its master that is visible without danger of the slave being
clipped by its parent. In addition, all slaves in one call to
grid must have the same master.
If the master for a slave is not its parent then you must make
sure that the slave is higher in the stacking order than the
master.  The easiest
way to make sure the slave is higher than the master is to create
the master window first: the most recently created window will be
highest in the stacking order.
The grid command is based on ideas taken from the
GridBag geometry manager written by Doug. Stein, and the
blt_table geometry manager, written by George Howlett.
geometry
manager, location, grid, cell, propagation, size, pack
Copyright © 1996 Sun Microsystems, Inc.
Copyright © 1995-1997 Roger E. Critchlow Jr.


--- layout: post title: Setting up WiFi that is using two Internet Service Provider simultanously (load-balanced) date: 2017-02-27 00:00:00.000000000 +08:00 permalink: setting-up-wifi-that-is-using-two-internet-service-provider-simultanously-load-balanced/ header-img: "img/20586158743_46b96ef40b_k.jpg" subtitle: "Traditionally, if you have a backup Internet connection, you can only use that after the primary connection failed. But what if, you can combine those two and use them simultanously?" ---
In order to understand how this is going to work, you need to understand what each component does and how it will do the intended purpose.
Wifi users connects to the WiFi router as they usually do, then the WiFi router simply forwards these requests to TL-R470T+.
Basically, the TL-R470T+ "splits" the traffic between the two Internet provider by doing the low level networking and abstracting things from the WiFi router and users. In their point of view it just use TL-R470T+ as a default gateway for Internet traffic.
Plug your 2 ISP connection to the WAN slots and connect your PC/laptop to LAN slot. For now, you can run through a LAN cable directly to the device, so you can set it up.
Plug the TL-R470T+ into power and boot it up.
Once connected, connect to the device by opening http://<IP_ADDRESS>
It will show you the login of device portal. Username is admin and the password is admin.
From there, choose the "Quick Setup". Just follow the instructions in the Wizard and you should be good to go.
Next step is to configure the Wifi router. It usually depends on the type of WiFi router you have. But one important thing to point out are.
Once you are setup. You should check the PDF guide for more advanced configuration. Like Bandwidth Based Balance Routing, Application Optimized Routing, and Policy Routing to optimize bandwidth usage.