TWAIN Programming Guide

Triplet Reference

 

DG_CONTROL / DAT_IDENTITY


DG_CONTROL / DAT_IDENTITY / MSG_OPENDS

[Description]

Loads the specified Source into main memory and causes its initialization. If scanner driver is not installed correctly, or scanner is not turned on, data source returns TWRC_FAILURE / TWCC_OPERATIONERROR.

DG_CONTROL / DAT_IDENTITY / MSG_CLOSEDS

[Description]

Closes the Source so it can be unloaded from memory.

 

DG_CONTROL / DAT_CUSTOMDSDATA


DG_CONTROL / DAT_CUSTOMDSDATA / MSG_GET

[Description]

Get current setting list as a text data. Application can save it internally and use it later. It is used after DG_CONTROL / DAT_USERINTERFACE / MSG_ENABLEDSUIONLY normally.

DG_CONTROL / DAT_CUSTOMDSDATA / MSG_SET

[Description]

Application can specify scan setting using text data that is stored in the application using MSG_GET

Note:
Editing of text data is not allowed. Please do not change inside of text data.
DG_CONTROL / DAT_CUSTOMDSDATA / MSG_GET DG_CONTROL / DAT_CUSTOMDSDATA / MSG_SET doesn’t support Dual Image Output. It always works as OFF.

 

DG_CONTROL / DAT_CAPABILITY


DG_CONTROL / DAT_CAPABILITY / MSG_GET

[Description]

Returns the Source's Current, Default and Available Values for a specified capability

DG_CONTROL / DAT_CAPABILITY / MSG_GETCURRENT

[Description]

Returns the Source's Current Value for the specified capability

DG_CONTROL / DAT_CAPABILITY / MSG_GETDEFAULT

[Description]

Returns the Source's Default Value for the specified capability

DG_CONTROL / DAT_CAPABILITY / MSG_RESET

[Description]

Change the Current Value of the specified capability back to its power-on value and return the new Current Value

DG_CONTROL / DAT_CAPABILITY / MSG_SET

[Description]

Changes the Current Value(s) and Available Values of the specified capability to those specified by the application

 

DG_CONTROL / DAT_EVENT


DG_CONTROL / DAT_EVENT / MSG_PROCESSEVENT

[Description]

Forwards events from the application to Sources

 

DG_CONTROL / DAT_PENDINGXFERS


DG_CONTROL / DAT_PENDINGXFERS / MSG_ENDXFER

[Description]

This is used to cancel or terminate a transfer

DG_CONTROL / DAT_PENDINGXFERS / MSG_GET

[Description]

Returns the number of transfers the Source is ready to supply to the application

DG_CONTROL / DAT_PENDINGXFERS / MSG_RESET

[Description]

Sets the number of pending transfers in the Source to zero.

 

DG_CONTROL / DAT_SETUPFILEXFER


DG_CONTROL / DAT_SETUPFILEXFER / MSG_GET

[Description]

Returns the file related information like target folder, filename and so on.

DG_CONTROL / DAT_SETUPFILEXFER / MSG_SET

[Description]

Set the file related information like target folder, filename and so on.

 

DG_CONTROL / DAT_SETUPMEMXFER


DG_CONTROL / DAT_SETUPMEMXFER / MSG_GET

[Description]

Returns the Source’s preferred, minimum, and maximum allocation sizes for transfer memory buffers

 

DG_CONTROL / DAT_USERINTERFACE


DG_CONTROL / DAT_USERINTERFACE / MSG_DISABLEDS

[Description]

Causes the Source’s user interface to be lowered

DG_CONTROL / DAT_USERINTERFACE / MSG_ENABLEDS

[Description]

Causes the source to be placed into a ready to acquire condition. This raises the Source’s built-in user interface and to terminates Source’s acceptance of "set capability” requests from the application. If TW_USERINTERFACE.ShowUI is set to FALSE, the built-in user interface is suppressed.

DG_CONTROL / DAT_USERINTERFACE / MSG_ENABLEDSUIONLY

[Description]

It shows Source’s built-in user interface for setting. It is for setting only then doesn’t have a Scan button.

 

DG_IMAGE / DAT_IMAGEINFO


DG_IMAGE / DAT_IMAGEINFO / MSG_GET

[Description]

Provides the application with general image description information about the image to be transferred.

 

DG_IMAGE / DAT_IMAGELAYOUT


DG_IMAGE / DAT_IMAGELAYOUT / MSG_GET

[Description]

Describes both the size and placement of the image on the original "page"

DG_IMAGE / DAT_IMAGELAYOUT / MSG_GETDEFAULT

[Description]

Returns the default information on the layout of an image

Note:
Maximum scanning region size depends on document source, i.e. document table, auto document feeder or transparency unit. The value for current document source will be returned.

DG_IMAGE / DAT_IMAGELAYOUT / MSG_RESET

[Description]

Sets the image layout information for the next transfer to its default settings

Note:
Maximum scanning region size depends on document source, i.e. document table, auto document feeder or transparency unit. The value for current document source will be set to default value.

DG_IMAGE / DAT_IMAGELAYOUT / MSG_SET

[Description]

Sets the layout for the next image transfer

Note:
Make sure to specify scanning region with DAT_IMAGELAYOUT after specified which document source (document table, Auto Document Feeder, Multi Photo Feeder or Transparency unit) is used. Since maximum size of scanning region depends on document source, setting of scanning region is set to default correspondent to document source after document source is changed. In order to specify document source, use CAP_FEEDERENABLE for Auto Document Feeder or Multi Photo Feeder, and use ICAP_LIGHTPATH for transparency unit respectively. In addition, according to document source, returned value of ICAP_PHYSICALWIDTH and ICAP_PHYSICALHEIGHT returns maximum size of scanning region depending on document source.

 

DG_IMAGE / DAT_IMAGEFILEXFER


DG_IMAGE / DAT_IMAGEFILEXFER / MSG_GET

[Description]

Initiates the transfer of an image from the Source to the application via the File transfer mechanism.

 

DG_IMAGE / DAT_IMAGEMEMXFER


DG_IMAGE / DAT_IMAGEMEMXFER / MSG_GET

[Description]

Initiates the transfer of an image from the Source to the application via the Buffered Memory transfer mechanism. Image data is sent block by block. Size of a block is set in a member of TW_IMAGEMEMXFER structure.

 

DG_IMAGE / DAT_IMAGENATIVEXFER


DG_IMAGE / DAT_IMAGENATIVEXFER / MSG_GET

[Description]

Causes the transfer of an image’s data from the Source to the application, via the Native transfer mechanism In Windows, the image format that is used for transfer is DIB and in Macintosh, PICT.