Name 

Description 

 

TwainAcquireToDib 

Acquires a single image, from the currently selected Data Source to a DIB handle. 

 

TwainAcquireToFile 

Acquires a single image, from the currently selected Data Source to a file.
This function uses only the File transfer mode.
The disk file mode is ideal when transferring large images that might encounter memory limitations with Native or memory mode.
However, Disk File mode is a bit slower than other transfer mode.

-> The output image format should be negotiated with the TwainSetImageFileFormat() function.
-> The output image compression should be negotiated with the TwainSetCompression() function.  

 

TwainAcquireToGdPictureImage 

Acquires a single image, from the currently selected Data Source.  

 

TwainBarCodeGetConfidence 

Returns the degree of certainty of a bar code the engine has in the accuracy of the information obtained on the last acquired image.  

 

TwainBarCodeGetCount 

If barcode detection is enabled, returns the number of bar codes found on the last acquired image.  

 

TwainBarCodeGetRotation 

Returns the orientation of a bar code found on the last acquired image.  

 

TwainBarCodeGetType 

Returns the type of a bar code found on the last acquired image.  

 

TwainBarCodeGetValue 

Returns the text of a bar code found on the last acquired image.  

 

TwainBarCodeGetXPos 

Returns the X coordinate of a bar code found on the last acquired image.  

 

TwainBarCodeGetYPos 

Returns the Y coordinate of a bar code found on the last acquired image.  

 

TwainCloseSource 

Closes the open Data Source, if any.
If the source is enabled, disables it first.  

 

TwainCloseSourceManager 

Closes the Data Source Manager, if it is open.
If a source is open, disables and closes it as needed.  

 

TwainDisableSource 

Disables the open Data Source, if any.
This closes the source's user interface.  

 

TwainEnableDuplex 

Asks to the opened source to enable or disable the duplex scanning mode.  

 

TwainEndAllXfers 

Signals the Data Source to stop all the transfers.  

 

TwainEndXfer 

Signals the Data Source to stop the current transfer.
Go to either State 6 (TWAIN_TRANSFER_READY) if it has more transfers ready, or to State 5 (TWAIN_SOURCE_ENABLED) if it does not.  

 

TwainGetAvailableBarCodeTypeCount 

If barcode detection is available, returns the number of bar code types that can be detected.  

 

TwainGetAvailableBarCodeTypeNo 

Returns a supported bar code type which can be detected by the opened source.  

 

TwainGetAvailableBitDepthCount 

Returns the number of available bit depths values which can be used by the opened source in its current configuration.  

 

TwainGetAvailableBitDepthNo 

Returns an available bit depth value which can be used by the opened source in its current configuration.  

 

TwainGetAvailableBrightnessCount 

Returns the number of available brightness values which can be used by the opened source in its current configuration.  

 

TwainGetAvailableBrightnessNo 

Returns an available brightness value which can be used by the opened source in its current configuration.  

 

TwainGetAvailableCapValueNoNumeric 

Returns an available numeric value for the selected TWAIN capability which can be used by the opened source in its current configuration.
This function should be used to determine what are the supported value which can be used with the TwainSetCapCurrentNumeric() function.  

 

TwainGetAvailableCapValueNoString 

Returns an available string value for the selected TWAIN capability which can be used by the opened source in its current configuration.
This function should be used to determine what are the supported value which can be used with the TwainSetCapCurrentString() function.  

 

TwainGetAvailableCapValuesCount 

Returns the number of available values for the selected TWAIN capability which can be used with it by the opened source in its current configuration.  

 

TwainGetAvailableCompressionCount 

Returns the number of available compression values which can be used by the opened source in its current configuration for file transfer mode.  

 

TwainGetAvailableCompressionNo 

Returns an available compression value which can be used by the opened source in its current configuration for file transfer mode.  

 

TwainGetAvailableContrastCount 

Returns the number of available contrast values which can be used by the opened source in its current configuration.  

 

TwainGetAvailableContrastNo 

Returns an available contrast value which can be used by the opened source in its current configuration.  

 

TwainGetAvailableImageFileFormatCount 

Returns the number of available file format values which can be used by the opened source in its current configuration for file transfer mode.  

 

TwainGetAvailableImageFileFormatNo 

Returns an available image file format value which can be used by the opened source in its current configuration for file transfer mode.  

 

TwainGetAvailablePaperSizeCount 

Returns the number of available paper size values which can be used by the opened source.  

 

TwainGetAvailablePaperSizeNo 

Returns an available paper size value which can be used by the opened source.  

 

TwainGetAvailablePixelTypeCount 

Returns the number of available pixel types values which can be used by the opened source in its current configuration.  

 

TwainGetAvailablePixelTypeNo 

Returns an available pixel type value which can be used by the opened source in its current configuration.  

 

TwainGetAvailableXResolutionCount 

Returns the number of available X Resolutions values which can be used by the opened source in its current configuration.  

 

TwainGetAvailableXResolutionNo 

Returns an available X Resolution value which can be used by the opened source in its current configuration.  

 

TwainGetAvailableYResolutionCount 

Returns the number of available Y Resolutions values which can be used by the opened source in its current configuration.  

 

TwainGetAvailableYResolutionNo 

Returns an available Y Resolution value which can be used by the opened source in its current configuration.  

 

TwainGetBitDepth 

Returns the pixel bit depths for the Current value of PixelType. For example, when using TwainSetPixelType(TWPT_GRAY), this capability specifies whether this is 8-bit gray or 4-bit gray.  

 

TwainGetBitDepthReduction 

Returns Reduction Method the Source should use to reduce the bit depth of the data.  

 

TwainGetBrightness 

Returns the current brightness.  

 

TwainGetCapCurrentNumeric 

Returns as numeric, the current value of a TWAIN capability.  

 

TwainGetCurrentSourceName 

Returns the name of the opened source.  

 

TwainGetCapCurrentString 

Returns as string, the current value of a TWAIN capability.  

 

TwainGetDefaultSourceName 

Returns the name of the default TWAIN source into the dialog of source selection.  

 

TwainGetEndorserNumber 

Returns the starting endorser / imprinter number for the next acquisition.  

 

TwainGetModalUI 

Asks if the TWAIN Source's GUI runs as modal or modeless.  

 

TwainGetSourceCount 

Returns the number of sources available.  

 

TwainGetSourceName 

Returns the name of an available TWAIN source.  

 

TwainGetCapItemType 

Returns the Item type used by a TWAIN capability.  

 

TwainGetCapRangeNumeric 

Returns the three parameters that define a Range for a TWAIN capability. Many capabilities allow users to select their current value from a range of regularly spaced values. The capability can specify the minimum and maximum acceptable values and the incremental step size between values. For example, resolution might be supported from 100 to 600 in steps of 50 (100, 150, 200, ..., 550, 600).  

 

TwainGetCompression 

Returns the current image compression used by the selected twain source for file transfer mode.  

 

TwainGetContrast 

Returns the current contrast.  

 

TwainGetDuplexMode 

Returns the duplex scanning support.  

 

TwainGetGamma 

Asks to the opened source for current Gamma correction value to apply to the scanned image.  

 

TwainGetHideUI 

Asks if the user interface should be hidden or not during an acquisition process.  

 

TwainGetImageFileFormat 

Returns the current image file format used by the selected twain source for file transfer mode.  

 

TwainGetImageLayout 

Returns the physical area (a rectangle) to be acquired during the next image transfer.  

 

TwainGetLastConditionCode 

Returns the last condition code from the last message sent to TWAIN.  

 

TwainGetLastResultCode 

Returns the last result code from the last message sent to TWAIN.  

 

TwainGetNoiseFilter 

Asks to the opened source for current algorithm used to remove noise for the selected twain source.  

 

TwainGetOrientation 

Asks to the opened source which edge of the “paper” the image’s “top” is aligned with.
This information is used to adjust the frames to match the scanning orientation of the paper.  

 

TwainGetPaperSize 

Gets the current paper size.  

 

TwainGetPhysicalHeight 

Returns the maximum height of the scanning area (in inches).  

 

TwainGetPhysicalWidth 

Returns the maximum width of the scanning area (in inches).  

 

TwainGetPixelFlavor 

Returns the pixel 'flavor' (0 is black or white).
CHOCOLATE means this pixel represents the darkest data value that can be generated by the device (the darkest available optical value may measure greater than 0).
VANILLA means this pixel represents the lightest data value that can be generated by the device (the lightest available optical value may measure greater than 0).  

 

TwainGetPixelType 

Asks the source for the current pixel type.  

 

TwainGetPlanarChunky 

Returns the color data formats There are two Options, "planar" And "chunky."  

 

TwainGetResolution 

Returns the current resolution in Dot per inch of the selected scanner.  

 

TwainGetRotation 

Asks to the opened source for current rotation to apply to the scanned image data prior to transfer.  

 

TwainGetState 

Returns the last Twain status.  

 

TwainGetThreshold 

Returns the dividing line between black and white. This is the value the Source will use to threshold, if needed, when scanning B&W image.  

 

TwainGetXScaling 

Asks to the opened source for current horizontal scaling to apply to the scanned image.  

 

TwainGetYScaling 

Asks to the opened source for current vertical scaling to apply to the scanned image.  

 

TwainHasCameraPreviewUI 

Queries the current device for UI support for preview mode.  

 

TwainHasFeeder 

Asks to the opened source if it has a document feeder.  

 

TwainHasFlatBed 

Asks to the opened source if it has a flatbed.  

 

TwainIsAutoBrightnessAvailable 

Asks to the opened source if she can support the auto-brightness images capability.  

 

TwainIsAutoBrightnessEnabled 

Asks to the opened source if the auto-brightness images capability is enabled or not.  

 

TwainIsAutoFeedAvailable 

Asks to the opened source if she can support the automatic page feeding capability.
When AutoFeed capability is enabled, the Source will automatically feed the next page from the document feeder after the number of frames negotiated for capture from each page are acquired.  

 

TwainIsAutoFeedEnabled 

Asks to the opened source if the automatic page feeding capability is enabled or not.  

 

TwainIsAutomaticBorderDetectionAvailable 

Asks to the opened source if she can support the Automatic border detection capability.  

 

TwainIsAutomaticBorderDetectionEnabled 

Asks to the opened source if the Automatic border detection capability is enabled or not.  

 

TwainIsAutomaticDeskewAvailable 

Asks to the opened source if she can support the Automatic Deskew capability.  

 

TwainIsAutomaticDeskewEnabled 

Asks to the opened source if the Automatic Deskew capability is enabled or not.  

 

TwainIsAutomaticDiscardBlankPagesAvailable 

Asks to the opened source if she can support the Automatic discard blank images capability.  

 

TwainIsAutomaticDiscardBlankPagesEnabled 

Asks to the opened source if the Automatic discard blank images capability is enabled or not.  

 

TwainIsAutomaticRotationAvailable 

Asks to the opened source if she can support the Automatic rotation of images capability.
This capability depends on intelligent features within the Source to automatically rotate the image to the correct position.  

 

TwainIsAutomaticRotationEnabled 

Asks to the opened source if the automatic rotation of images capability is enabled or not.  

 

TwainIsAutoScanAvailable 

Asks to the opened source if she can support the automatic scan capability.
This capability is intended to boost the performance of a Source.
The fundamental assumption behind AutoScan is that the device is able to capture images without waiting for the Application to request the image transfers.
The default behavior is undefined, because some high volume devices are capable of anything but TwainIsAutoScanAvailable() return value being equal to TRUE.  

 

TwainIsAutoScanEnabled 

Asks to the opened source if the automatic scan capability is enabled or not.  

 

TwainIsAutoSizeAvailable 

Asks to the opened source if she can support the auto-size images capability.  

 

TwainIsAutoSizeEnabled 

Asks to the opened source if the auto-size images capability is enabled or not.  

 

TwainIsAvailable 

This function find out if TWAIN is installed on the system.
It takes a little time on the first call.  

 

TwainIsBarcodeDetectionAvailable 

Asks to the opened source if she can support the barcode detection capability.  

 

TwainIsBarcodeDetectionEnabled 

Asks to the opened source if the barcode detection capability is enabled or not.  

 

TwainIsDeviceOnline 

Returns the online statue of the current data source.  

 

TwainIsDuplexEnabled 

Ask to the opened source if duplex scanning is currently enabled or not.  

 

TwainIsEndorserAvailable 

Asks to the opened source if she can support endorser / imprinter capability.  

 

TwainIsFeederLoaded 

Asks to the opened source if there are documents in the feeder.  

 

TwainIsFeederSelected 

Asks to the opened source if the document feeder is selected.  

 

TwainIsFileTransferModeAvailable 

Asks to the opened source if the current data source supports file transfer mode.  

 

TwainIsGammaAvailable 

Asks to the opened source if she can support the gamma correction capability.  

 

TwainIsNoiseFilterAvailable 

Asks to the opened source if she can support the noise filter capability.  

 

TwainIsOrientationAvailable 

Asks to the opened source if she can support the image orientation capability.  

 

TwainIsPixelTypeAvailable 

Ask to the opened source if the device supports a kind of pixel type.  

 

TwainIsRotationAvailable 

Asks to the opened source if she can support the image rotation capability.  

 

TwainIsXScalingAvailable 

Asks to the opened source if she can support the image horizontal scaling capability.  

 

TwainIsYScalingAvailable 

Asks to the opened source if she can support the image vertical scaling capability.  

 

TwainLastXferFail 

Asks if the last acquisition process failed.  

 

TwainLoadConfiguration 

Loads from a file, settings of the opened source, e.g. DPI, paper size, color format.  

 

TwainLogStart 

Starts to log twain operations into file.  

 

TwainLogStop 

Stops to log twain operations previously started by the TwainLogStart() function.  

 

TwainOpenDefaultSource 

This opens the source selected in the Select Source dialog.
If some source is already open, does nothing and returns TRUE.
First this function for each scanning process or to set the TWAIN state to 4 (TWAIN_SOURCE_OPEN) when the TWAIN state is 3 (TWAIN_SM_OPEN) or 2 (TWAIN_SM_LOADED) or 1 (TWAIN_PRESESSION).  

 

TwainOpenSource 

Opens the source with the given name.
If another source is open, closes it and attempts to open the specified source.
First this function for each scanning process or to set the TWAIN state to 4 (TWAIN_SOURCE_OPEN) when the TWAIN state is 3 (TWAIN_SM_OPEN) or 2 (TWAIN_SM_LOADED) or 1 (TWAIN_PRESESSION).  

 

TwainResetCap 

Sets the current TWAIN capability value to default value.  

 

TwainResetImageLayout 

Asks to the opened device to reset the area to scan, sometimes called the ROI (Region of Interest).  

 

TwainSaveConfiguration 

Saves to a file current settings of the opened source, e.g. DPI, paper size, color format.  

 

TwainSelectFeeder 

Asks to the opened source to select or deselect the document feeder.  

 

TwainSelectSource 

Select twain device for capture. This function posts the Source Manager's Select Source dialog box.  

 

TwainSetApplicationInfo 

Asks to the component to register your application into TWAIN.  

 

TwainSetAutoBrightness 

Try to enable or disable autobrightness scanning.  

 

TwainSetAutoFeed 

Try to enable or disable the Source’s automatic document feeding process.
If you enable auto feed scanning, this function selects the feeder.
So to start scanning pages from an ADF, just do: TwainSetAutoFeed(TRUE).  

 

TwainSetAutomaticBorderDetection 

If this option is available on opened source, try to enable or disable the automatic border detection. It reduces or removes the border generated around an image by the scanner scanning its own platen (the area not covered by the paper).  

 

TwainSetAutomaticDeskew 

If this option is available on opened source, try to enable or disable the automatic deskew correction of an image. It may also affect the dimensions of the image.  

 

TwainSetAutomaticDiscardBlankPages 

If this option is available on opened source, try to enable or disable the automatic discard blank page capability.  

 

TwainSetAutomaticRotation 

If this option is available on opened source, try to enable or disable the automatic rotation of image capability.  

 

TwainSetAutoScan 

Tries to enable or disable the auto scan scanning capability. Setting this to TRUE gives the scanner permission to 'scan ahead'.
i.e. to pull pages from the feeder and scan them before they have been requested.
On high-speed scanners, you may have to enable auto scan to achieve the maximum scanning rate.  

 

TwainSetAutoSize 

If this option is available on opened source, try to enable or disable the auto-size images.  

 

TwainSetAutoSourceClose 

Tells to the control to close or not the opened source after a scan process.  

 

TwainSetBarcodeDetection 

If this option is available on opened source, try to enable or disable the barcode detection.  

 

TwainSetBitDepth 

Specifies the pixel bit depths for the Current value of PixelType.
For example, when using TwainSetPixelType(TWPT_GRAY), this capability specifies whether this is 8-bit gray or 4-bit gray.  

 

TwainSetBitDepthReduction 

Tries to specifies the Reduction Method the Source should use to reduce the bit depth of the data.  

 

TwainSetBrightness 

Tries to set the current brightness for the next acquisition.  

 

TwainSetCapCurrentNumeric 

Changes the current value of a TWAIN capability from a numeric value.
The TwainGetAvailableCapValueNoNumeric() function should be used to determine what are the supported value which can be used with this function.  

 

TwainSetCapCurrentString 

Changes the current value of a TWAIN capability.  

 

TwainSetCompression 

Tries to set the current image compression to use by the selected twain source for file transfer mode.
Since only certain file formats support compression, this capability must be negotiated after setting the desired file format with the TwainSetImageFileFormat() function.  

 

TwainSetContrast 

Tries to set the current contrast for the next acquisition.  

 

TwainSetDebugMode 

Turns On or Off the Debug Mode of GDTWAIN.
Displays a message box for each step of the scanning process.  

 

TwainSetDSMPath 

Specifies the path TWAIN Data Source Manager.
The TWAIN DSM is the windows library (dll) providing support for the TWAIN standard.
Can be TWAIN_32.DLL or TWAINDSM.DLL for TWAIN 2.0 support. By default, the toolkits searches the Windows path for the TWAIN DSM but on Citrix the Windows directory can be redirected for users.  

 

TwainSetEndorserNumber 

Tries to specify the starting endorser / imprinter number for the next acquisition. All other endorser/imprinter properties should be handled through the data source’s user interface.  

 

TwainSetErrorMessage 

Turns On or Off the error message box of GDTWAIN.
Displays a message box for each error appends.  

 

TwainSetGamma 

Tries to set the current gamma correction value for the selected twain source.  

 

TwainSetHideUI 

Tells the source to hide or show the user interface before acquisition.  

 

TwainSetImageFileFormat 

Tries to set the current image file format to use by the selected twain source for file transfer mode.  

 

TwainSetImageLayout 

Specifies the physical area (a rectangle) to be acquired during the next image transfer.  

 

TwainSetIndicators 

Tells the source to show or hide progress indicators during acquisition.  

 

TwainSetModalUI 

Set TRUE to run the TWAIN Source's GUI modal or FALSE to run it modeless. Please note that to successfully run modal, it may be necessary for the application to disable inputs to its windows while the Source’s GUI is running.  

 

TwainSetMultiTransfer 

Changes the multiple transfers mode for acquisition.  

 

TwainSetNoiseFilter 

Tries to set the current algorithm used to remove noise for the selected twain source.  

 

TwainSetOrientation 

Asks to the opened source to define which edge of the “paper” the image’s “top” is aligned with. This information is used to adjust the frames to match the scanning orientation of the paper.  

 

TwainSetPaperSize 

Sets the current paper size.  

 

TwainSetPixelFlavor 

Try to specify the pixel 'flavor' (0 is black or white).
CHOCOLATE means this pixel represents the darkest data value that can be generated by the device (the darkest available optical value may measure greater than 0).
VANILLA means this pixel represents the lightest data value that can be generated by the device (the lightest available optical value may measure greater than 0).  

 

TwainSetPixelType 

Tries to set the current pixel type for the selected twain source.  

 

TwainSetPlanarChunky 

Try to specify the color data formats There are two Options, "planar" And "chunky".  

 

TwainSetResolution 

Tries to set the current resolution (in both x & y).
Resolution is in dots per inch.  

 

TwainSetRotation 

Asks to the opened source to rotate the scanned image data prior to transfer.  

 

TwainSetThreshold 

Try to specify the dividing line between black and white. This is the value the Source will use to threshold, if needed, when scanning B&W image.  

 

TwainSetXferCount 

Negotiates with open Source the number of images application will accept.  

 

TwainSetXScaling 

Tries to set the current image horizontal scaling factor for the selected twain source.  

 

TwainSetYScaling 

Tries to set the current image vertical scaling factor for the selected twain source.  

 

TwainShowSetupDialogSource 

Starts the selected device's settings dialog, if this is supported.  

 

TwainUnloadSourceManager 

Unloads the Data Source Manager and release the TWAIN32.DLL.  

 

TwainUserClosedSource 

Asks if during the last acquisition process the user asked to close the device.