Sectors: Finance • Information Technoloy • Government • Healthcare • Industries • Education • (show all)
Asynchronous Device Events | |
CAP_DEVICEEVENT | MSG_SET selects which events the application wants the source to report; MSG_RESET resets the capability to the empty array (no events set). |
Audible Alarms | |
CAP_ALARMS | Turns specific audible alarms on and off. |
CAP_ALARMVOLUME | Controls the volume of a device’s audible alarm. |
Audio | |
ACAP_XFERMECH | Allows application and source to identify which audio transfer mechanisms they have in common. |
Automatic Adjustments | |
CAP_AUTOMATICSENSEMEDIUM | Configures a Source to check for paper in the Automatic Document Feeder. |
ICAP_AUTODISCARDBLANKPAGES | Discards blank pages. |
ICAP_AUTOMATICBORDERDETECTION | Turns automatic border detection on and off. |
ICAP_AUTOMATICCOLORENABLED | Detects the pixel type of the image and returns either a color image or a non-color image specified by ICAP_AUTOMATICCOLORNONCOLORPIXELTYPE |
ICAP_AUTOMATICCOLORNONCOLORPIXELTYPE | Specifies the non-color pixel type to use when automatic color is enabled. |
ICAP_AUTOMATICCROPUSESFRAME | Reduces the amount of data captured from the device, potentially improving the performance of the driver. |
ICAP_AUTOMATICDESKEW | Turns automatic skew correction on and off. |
ICAP_AUTOMATICLENGTHDETECTION | Controls the automatic detection of the length of a document, this is intended for use with an Automatic Document Feeder. |
ICAP_AUTOMATICROTATE | When TRUE , depends on source to automatically rotate the image. |
ICAP_AUTOSIZE | Force the output image dimensions to match either the current value of ICAP_SUPPORTEDSIZES or any of its current allowed values. |
ICAP_FLIPROTATION | Orients images that flip orientation every other image. |
ICAP_IMAGEMERGE | Merges the front and rear image of a document in one of four orientations: front on the top. |
ICAP_IMAGEMERGEHEIGHTTHRESHOLD | Specifies a Y-Offset in ICAP_UNITS units. |
Automatic Capture | |
CAP_AUTOMATICCAPTURE | Specifies the number of images to automatically capture. |
CAP_TIMEBEFOREFIRSTCAPTURE | Selects the number of seconds before the first picture taken. |
CAP_TIMEBETWEENCAPTURES | Selects the hundredths of a second to wait between pictures taken. |
Automatic Scanning | |
CAP_AUTOSCAN | Enables the source’s automatic document scanning process. |
CAP_CAMERAENABLED | Delivers images from the current camera. |
CAP_CAMERAORDER | Selects the order of output for Single Document Multiple Image mode. |
CAP_CAMERASIDE | Sets the top and bottom values of cameras in a scanning device. |
CAP_MAXBATCHBUFFERS | Describes the number of pages that the scanner can buffer when CAP_AUTOSCAN is enabled. |
Bar Code Detection Search Parameters | |
ICAP_BARCODEDETECTIONENABLED | Turns bar code detection on and off. |
ICAP_SUPPORTEDBARCODETYPES | Provides a list of bar code types that can be detected by current data source. |
ICAP_BARCODEMAXRETRIES | Restricts the number of times a search will be retried if no bar codes are found. |
ICAP_BARCODEMAXSEARCHPRIORITIES | Specifies the maximum number of supported search priorities. |
ICAP_BARCODESEARCHMODE | Restricts bar code searching to certain orientations, or prioritizes one orientation over another. |
ICAP_BARCODESEARCHPRIORITIES | A prioritized list of bar code types dictating the order in which they will be sought. |
ICAP_BARCODETIMEOUT | Restricts the total time spent on searching for bar codes on a page. |
Capability Negotiation Parameters | |
CAP_EXTENDEDCAPS | Capabilities negotiated in States 5, 6 and 7 |
CAP_SUPPORTEDCAPS | Inquire Source’s capabilities valid for MSG_GET |
CAP_SUPPORTEDDATS | Inquire Source’s DAT messages that are valid. |
Color | |
ICAP_COLORMANAGEMENTENABLED | Disables the Source’s color and gamma tables for color and grayscale images, resulting in output that that could be termed “raw”. |
ICAP_FILTER | Color characteristics of the subtractive filter applied to the image data |
ICAP_GAMMA | Gamma correction value for the image data |
ICAP_ICCPROFILE | Embeds or links ICC profiles into files |
ICAP_PLANARCHUNKY | Color data format - Planar or Chunky |
Compression | |
ICAP_BITORDERCODES | CCITT Compression |
ICAP_CCITTKFACTOR | CCITT Compression |
ICAP_COMPRESSION | Compression method for Buffered Memory Transfers |
ICAP_JPEGPIXELTYPE | JPEG Compression |
ICAP_JPEGQUALITY | JPEG quality |
ICAP_JPEGSUBSAMPLING | JPEG subsampling |
ICAP_PIXELFLAVORCODES | CCITT Compression |
ICAP_TIMEFILL | CCITT Compression |
Device Parameters | |
CAP_DEVICEONLINE | Determines if hardware is on and ready |
CAP_DEVICETIMEDATE | Date and time of a device’s clock. |
CAP_SERIALNUMBER | The serial number of the currently selected source device. |
ICAP_MINIMUMHEIGHT | Allows the source to define the minimum height (Y-axis) that the source can acquire. |
ICAP_MINIMUMWIDTH | Allows the source to define the minimum width (X-axis) that the source can acquire. |
ICAP_EXPOSURETIME | Exposure time used to capture the image, in seconds |
ICAP_FLASHUSED | For devices that support a flash, MSG_SET selects the flash to be used; MSG_GET reports the current setting. |
ICAP_IMAGEFILTER | For devices that support image filtering, selects the algorithm to be used. |
ICAP_LAMPSTATE | Is the lamp on? |
ICAP_LIGHTPATH | Image was captured transmissively or reflectively |
ICAP_LIGHTSOURCE | Describes the color characteristic of the light source used to acquire the image |
ICAP_NOISEFILTER | For devices that support noise filtering, selects the algorithm to be used. |
ICAP_OVERSCAN | For devices that support overscanning, controls whether additional rows or columns are appended to the image. |
ICAP_PHYSICALHEIGHT | Maximum height Source can acquire (in ICAP_UNITS ) |
ICAP_PHYSICALWIDTH | Maximum width Source can acquire (in ICAP_UNITS ) |
ICAP_UNITS | Unit of measure (inches, centimeters, etc.) |
ICAP_ZOOMFACTOR | With MSG_GET , returns all camera supported lens zooming range. |
Doublefeed Detection | |
CAP_DOUBLEFEEDDETECTION | Control DFD functionality |
CAP_DOUBLEFEEDDETECTIONLENGTH | Set the minimum length |
CAP_DOUBLEFEEDDETECTIONSENSITIVITY | Set detector sensitivity |
CAP_DOUBLEFEEDDETECTIONRESPONSE | Describe Source behavior in case of DFD |
Imprinter/Endorser Functionality | |
CAP_ENDORSER | Allows the application to specify the starting endorser / imprinter number. |
CAP_PRINTER | MSG_GET returns current list of available printer devices; MSG_SET selects the device for negotiation. |
CAP_PRINTERCHARROTATION | Orientation of each character in the font |
CAP_PRINTERENABLED | Turns the current CAP_PRINTER device on or off. |
CAP_PRINTERFONTSTYLE | Style (ex: bold, italic…) |
CAP_PRINTERINDEX | Starting number for the CAP_PRINTER device. |
CAP_PRINTERINDEXLEADCHAR | Lead character for padding |
CAP_PRINTERINDEXMAXVALUE | Maximum allowed printer index value |
CAP_PRINTERINDEXNUMDIGITS | Maximum allowed digits in printer index value |
CAP_PRINTERINDEXSTEP | Increment between printer index values |
CAP_PRINTERINDEXTRIGGER | Triggers for incrementing the printer index value |
CAP_PRINTERMODE | Specifies appropriate current CAP_PRINTER device mode. |
CAP_PRINTERSTRING | String(s) to be used in the string component when CAP_PRINTER device is enabled. |
CAP_PRINTERSTRINGPREVIEW | Preview of what a printer string will look like |
CAP_PRINTERSUFFIX | String to be used as current CAP_PRINTER device’s suffix. |
CAP_PRINTERVERTICALOFFSET | Y-Offset for current CAP_PRINTER device |
Image Addressing | |
CAP_IMAGEADDRESSENABLED | Turns image addressing on or off |
CAP_IAFIELDA_LEVEL | Sets the image addressing level of this field (a scanner can support up to five fields, listed CAP_IAFIELDA_ * through CAP_IAFIELDE_ *) |
CAP_IAFIELDA_PRINTFORMAT | Selects the formatting for printing and reporting the image address |
CAP_IAFIELDA_VALUE | The image address of the next page to be scanned when scanning starts |
CAP_IAFIELDA_LASTPAGE | The image address of the last scanned page |
Image Information | |
CAP_AUTHOR | Author of acquired image (may include a copyright string) |
CAP_CAPTION | General note about acquired image |
CAP_TIMEDATE | Date and Time the image was acquired (entered State 7) |
ICAP_EXTIMAGEINFO | Allows the application to query the data source to see if it supports the new operation triplet DG_IMAGE / DAT_EXTIMAGEINFO / MSG_GET . |
ICAP_SUPPORTEDEXTIMAGEINFO | Lists all of the information that the Source is capable of returning from a call to DAT_EXTIMAGEINFO . |
Image Parameters for Acquire | |
CAP_THUMBNAILSENABLED | Allows an application to request the delivery of thumbnail representations for the set of images that are to be delivered. |
ICAP_AUTOBRIGHT | Enable Source’s Auto-brightness function |
ICAP_BRIGHTNESS | Source brightness values |
ICAP_CONTRAST | Source contrast values |
ICAP_HIGHLIGHT | Lightest highlight, values lighter than this value will be set to this value |
ICAP_IMAGEDATASET | Gets or sets the image indices that will be delivered during the standard image transfer done in States 6 and 7. |
ICAP_MIRROR | Source can, or should, mirror image. |
ICAP_ORIENTATION | Defines which edge of the paper is the top: Portrait or Landscape |
ICAP_ROTATION | Source can, or should, rotate image this number of degrees |
ICAP_SHADOW | Darkest shadow, values darker than this value will be set to this value |
ICAP_XSCALING | Source Scaling value (1.0 = 100%) for x-axis |
ICAP_YSCALING | Source Scaling value (1.0 = 100%) for y-axis |
Image Type | |
ICAP_BITDEPTH | Pixel bit depth for Current value of ICAP_PIXELTYPE |
ICAP_BITDEPTHREDUCTION | Allows a choice of the reduction method for bit depth loss |
ICAP_BITORDER | Specifies how the bytes in an image are filled by the Source |
ICAP_CUSTHALFTONE | Square-cell halftone (dithering) matrix to be used |
ICAP_HALFTONES | Source halftone patterns |
ICAP_PIXELFLAVOR | Sense of the pixel whose numeric value is zero |
ICAP_PIXELTYPE | The type of pixel data (B/W, gray, color, etc.) |
ICAP_THRESHOLD | Specifies the dividing line between black and white values |
Language Support | |
CAP_LANGUAGE | Allows application and source to identify which languages they have in common. |
MICR | |
CAP_MICRENABLED | Enables actions needed to support check scanning. |
Pages | |
CAP_SEGMENTED | Describes the segmentation setting for captured images |
ICAP_FRAMES | Size and location of frames on page |
ICAP_MAXFRAMES | Maximum number of frames possible per page |
ICAP_SUPPORTEDSIZES | Fixed frame sizes for typical page sizes |
Paper Handling | |
CAP_AUTOFEED | MSG_SET to TRUE to enable Source’s automatic feeding |
CAP_CLEARPAGE | MSG_SET to TRUE to eject current page and leave acquire area empty |
CAP_DUPLEX | Indicates whether the scanner supports duplex. |
CAP_DUPLEXENABLED | Enables the user to set the duplex option to be TRUE or FALSE . |
CAP_FEEDERALIGNMENT | Indicates the alignment of the document feeder. |
CAP_FEEDERENABLED | If TRUE , Source’s feeder is available |
CAP_FEEDERLOADED | If TRUE , Source has documents loaded in feeder ( MSG_GET only) |
CAP_FEEDERORDER | Specifies whether feeder starts with top of first or last page. |
CAP_FEEDERPOCKET | Report what pockets are available as paper leaves a device. |
CAP_FEEDERPREP | Improve the movement of paper through a scanner ADF. |
CAP_FEEDPAGE | MSG_SET to TRUE to eject current page and feed next page |
CAP_PAPERDETECTABLE | Determines whether source can detect documents on the ADF or flatbed. |
CAP_PAPERHANDLING | Control paper handling |
CAP_REACQUIREALLOWED | Capable of acquring muliple images of the same page wihtout changing the physical registraion of that page. |
CAP_REWINDPAGE | MSG_SET to TRUE to do a reverse feed |
ICAP_FEEDERTYPE | Allows application to set scan parameters depending on the type of feeder being used. |
Patch Code Detection | |
ICAP_PATCHCODEDETECTIONENABLED | Turns patch code detection on and off. |
ICAP_SUPPORTEDPATCHCODETYPES | List of patch code types that can be detected by current data source. |
ICAP_PATCHCODEMAXSEARCHPRIORITIES | Maximum number of search priorities. |
ICAP_PATCHCODESEARCHPRIORITIES | List of patch code types dictating the order in which patch codes will be sought. |
ICAP_PATCHCODESEARCHMODE | Restricts patch code searching to certain orientations, or prioritizes one orientation over another. |
ICAP_PATCHCODEMAXRETRIES | Restricts the number of times a search will be retried if none are found on a page. |
ICAP_PATCHCODETIMEOUT | Restricts total time for searching for a patch code on a page. |
Power Monitoring | |
CAP_BATTERYMINUTES | The minutes of battery power remaining on a device. |
CAP_BATTERYPERCENTAGE | With MSG_GET , indicates battery power status. |
CAP_POWERSAVETIME | With MSG_SET , sets the camera power down timer in seconds; with MSG_GET , returns the current setting of the power down time. |
CAP_POWERSUPPLY | MSG_GET reports the kinds of power available; MSG_GETCURRENT reports the current power supply to use. |
Resolution | |
ICAP_XNATIVERESOLUTION | Native optical resolution of device for x-axis |
ICAP_XRESOLUTION | Current/Available optical resolutions for x-axis |
ICAP_YNATIVERESOLUTION | Native optical resolution of device for y-axis |
ICAP_YRESOLUTION | Current/Available optical resolutions for y-axis |
Transfers | |
CAP_JOBCONTROL | Allows multiple jobs in batch mode. |
CAP_SHEETCOUNT | Number of sheets the application is willing to accept this session (valid when CAP_XFERCOUNT is -1) |
CAP_XFERCOUNT | Number of images the application is willing to accept this session |
ICAP_COMPRESSION | Buffered Memory transfer compression schemes |
ICAP_IMAGEFILEFORMAT | File formats for file transfers |
ICAP_TILES | Tiled image data |
ICAP_UNDEFINEDIMAGESIZE | The application will accept undefined image size |
ICAP_XFERMECH | Transfer mechanism - used to learn options and set-up for upcoming transfer |
User Interface | |
CAP_CAMERAPREVIEWUI | Queries the source for UI support for preview mode. |
CAP_CUSTOMDSDATA | Allows the application to query the data source to see if it supports the new operation triplets DG_CONTROL / DAT_CUSTOMDSDATA / MSG_GET and DG_CONTROL / DAT_CUSTOMDSDATA / MSG_SET . |
CAP_CUSTOMINTERFACEGUID | Uniquely identifies an interface for a Data Source. |
CAP_ENABLEDSUIONLY | Queries an application to see if it implements the new user interface settings dialog. |
CAP_INDICATORS | Use the Source’s progress indicator? (valid only when ShowUI== FALSE ) |
CAP_INDICATORSMODE | List of messages types that can be display if ICAP_INDICATORS is TRUE |
CAP_UICONTROLLABLE | Indicates that Source supports acquisitions with UI disabled |
Where would you like to scan from? Scan in Web Apps Scan in Java Scan in .NET
The TWAIN Toolkit is distributed as is. The developer and distributors of the TWAIN Toolkit expressly disclaim all implied, express or statutory warranties including, without limitation, the implied warranties of merchantability, noninfringement of third party rights and fitness for a particular purpose. Neither the developers nor the distributors will be liable for damages, whether direct, indirect, special, incidental, or consequential, as a result of the reproduction, modification, distribution or other use of the TWAIN Toolkit.